Class: VertxShell::Term

Inherits:
Tty
  • Object
show all
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb

Overview

The terminal.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Tty

#height, #type, #width

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


23
24
25
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 23

def @@j_api_type.accept?(obj)
  obj.class == Term
end

+ (Object) j_api_type



32
33
34
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 32

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



35
36
37
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 35

def self.j_class
  Java::IoVertxExtShellTerm::Term.java_class
end

+ (Object) unwrap(obj)



29
30
31
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 29

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)



26
27
28
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 26

def @@j_api_type.wrap(obj)
  Term.new(obj)
end

Instance Method Details

- (void) close

This method returns an undefined value.

Close the connection to terminal.


141
142
143
144
145
146
147
148
149
150
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 141

def close
  if !block_given?
    return @j_del.java_method(:close, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling close()"
  end
end

- (self) closeHandler(handler) { ... }

Set a handler that will be called when the terminal is closed.

Yields:

  • the handler

Returns:

  • (self)


127
128
129
130
131
132
133
134
135
136
137
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 127

def close_handler
  if true
    @j_del.java_method(:closeHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(nil) unless !block_given? }))
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling close_handler()"
  end
end

- (self) echo(text)

Echo some text in the terminal, escaped if necessary.

Parameters:

  • text (String)
    the text to echo

Returns:

  • (self)


98
99
100
101
102
103
104
105
106
107
108
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 98

def echo(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:echo, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling echo(#{args[0]})"
  end
end

- (self) interruptHandler(handler)

Set an interrupt signal handler on the term.

Parameters:

Returns:

  • (self)


83
84
85
86
87
88
89
90
91
92
93
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 83

def interrupt_handler(*args)
  if args[0].class.method_defined?(:j_del) && !block_given?
    @j_del.java_method(:interruptHandler, [Java::IoVertxExtShellTerm::SignalHandler.java_class]).call(args[0].j_del)
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling interrupt_handler(#{args[0]})"
  end
end

- (Fixnum) lastAccessedTime

Returns the last time this term received input

Returns:

  • (Fixnum)
    the last time this term received input


40
41
42
43
44
45
46
47
48
49
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 40

def last_accessed_time
  if !block_given?
    return @j_del.java_method(:lastAccessedTime, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling last_accessed_time()"
  end
end

- (void) readline(prompt, lineHandler) { ... } - (void) readline(prompt, lineHandler, completionHandler) { ... }

This method returns an undefined value.

Prompt the user a line of text, providing a completion handler to handle user's completion.

Overloads:

  • - (void) readline(prompt, lineHandler) { ... }

    Parameters:

    • prompt (String)
      the displayed prompt

    Yields:

    • the line handler called with the line
  • - (void) readline(prompt, lineHandler, completionHandler) { ... }

    Parameters:

    • prompt (String)
      the displayed prompt
    • lineHandler (Proc)
      the line handler called with the line

    Yields:

    • the completion handler


174
175
176
177
178
179
180
181
182
183
184
185
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 174

def readline(*args)
  if args[0].class == String && true && args[1] == nil
    return @j_del.java_method(:readline, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(args[0],(Proc.new { |event| yield(event) unless !block_given? }))
  elsif args[0].class == String && args[1].class == Proc && true
    return @j_del.java_method(:readline, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(args[0],(Proc.new { |event| args[1].call(event) unless args[1] == nil }),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::VertxShell::Completion)) unless !block_given? }))
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling readline(#{args[0]},#{args[1]})"
  end
end

- (self) resizehandler(handler) { ... }

Yields:

Returns:

  • (self)


189
190
191
192
193
194
195
196
197
198
199
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 189

def resizehandler
  if true
    @j_del.java_method(:resizehandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(nil) unless !block_given? }))
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling resizehandler()"
  end
end

- (::VertxShell::Term) setSession(session)

Associate the term with a session.

Parameters:

Returns:



113
114
115
116
117
118
119
120
121
122
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 113

def set_session(*args)
  if args[0].class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:setSession, [Java::IoVertxExtShellSession::Session.java_class]).call(args[0].j_del),::VertxShell::Term)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_session(#{args[0]})"
  end
end

- (self) stdinHandler(handler) { ... }

Yields:

Returns:

  • (self)


68
69
70
71
72
73
74
75
76
77
78
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 68

def stdin_handler
  if true
    @j_del.java_method(:stdinHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(event) unless !block_given? }))
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling stdin_handler()"
  end
end

- (self) suspendHandler(handler)

Set a suspend signal handler on the term.

Parameters:

Returns:

  • (self)


54
55
56
57
58
59
60
61
62
63
64
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 54

def suspend_handler(*args)
  if args[0].class.method_defined?(:j_del) && !block_given?
    @j_del.java_method(:suspendHandler, [Java::IoVertxExtShellTerm::SignalHandler.java_class]).call(args[0].j_del)
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling suspend_handler(#{args[0]})"
  end
end

- (self) write(data)

Parameters:

  • data (String)

Returns:

  • (self)


154
155
156
157
158
159
160
161
162
163
164
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/term.rb', line 154

def write(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:write, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling write(#{args[0]})"
  end
end