Class: VertxShell::Shell

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

Overview

An interactive session between a consumer and a shell.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


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

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

+ (Object) j_api_type



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

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



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

def self.j_class
  Java::IoVertxExtShell::Shell.java_class
end

+ (Object) unwrap(obj)



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

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

+ (Object) wrap(obj)



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

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

Instance Method Details

- (void) close

This method returns an undefined value.

Close the shell.


87
88
89
90
91
92
93
94
95
96
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/shell.rb', line 87

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

- (::VertxShell::Job) createJob(line) - (::VertxShell::Job) createJob(line)

Overloads:

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/shell.rb', line 72

def create_job(*args)
  if args[0].class == Array && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:createJob, [Java::JavaUtil::List.java_class]).call(args[0].map { |element| element.j_del }),::VertxShell::Job)
  elsif args[0].class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:createJob, [Java::java.lang.String.java_class]).call(args[0]),::VertxShell::Job)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling create_job(#{args[0]})"
  end
end

- (::VertxShell::JobController) jobController

Returns the shell's job controller

Returns:



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

def job_controller
  if !block_given?
    if @cached_job_controller != nil
      return @cached_job_controller
    end
    return @cached_job_controller = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:jobController, []).call(),::VertxShell::JobController)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling job_controller()"
  end
end

- (::VertxShell::Session) session

Returns the current shell session

Returns:



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

def session
  if !block_given?
    if @cached_session != nil
      return @cached_session
    end
    return @cached_session = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:session, []).call(),::VertxShell::Session)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling session()"
  end
end

- (void) setPrompt(prompt) { ... }

This method returns an undefined value.

Set a new prompt in this session.

Yields:

  • the new prompt will be calculated when it's needed.


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

def set_prompt(*args)
  if block_given? && args[0] == nil
    return @j_del.java_method(:setPrompt, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::VertxShell::Session)) unless !block_given? }))
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_prompt(#{args[0]})"
  end
end