Class: VertxShell::Completion

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

Overview

The completion object

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


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

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

+ (Object) j_api_type



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

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



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

def self.j_class
  Java::IoVertxExtShellCli::Completion.java_class
end

+ (Object) unwrap(obj)



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

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

+ (Object) wrap(obj)



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

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

Instance Method Details

- (void) complete(candidates) - (void) complete(value, terminal)

This method returns an undefined value.

End the completion with a value that will be inserted to complete the line.

Overloads:

  • - (void) complete(candidates)

    Parameters:

    • candidates (Array<String>)
      the candidates
  • - (void) complete(value, terminal)

    Parameters:

    • value (String)
      the value to complete with
    • terminal (true, false)
      true if the value is terminal, i.e can be further completed


91
92
93
94
95
96
97
98
99
100
101
102
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/completion.rb', line 91

def complete(*args)
  if args[0].class == Array && !block_given? && args[1] == nil
    return @j_del.java_method(:complete, [Java::JavaUtil::List.java_class]).call(args[0].map { |element| element })
  elsif args[0].class == String && (args[1].class == TrueClass || args[1].class == FalseClass) && !block_given?
    return @j_del.java_method(:complete, [Java::java.lang.String.java_class,Java::boolean.java_class]).call(args[0],args[1])
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling complete(#{args[0]},#{args[1]})"
  end
end

- (Array<::VertxShell::CliToken>) lineTokens

Returns the current line being completed as preparsed tokens

Returns:



62
63
64
65
66
67
68
69
70
71
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/completion.rb', line 62

def line_tokens
  if !block_given?
    return @j_del.java_method(:lineTokens, []).call().to_a.map { |elt| ::Vertx::Util::Utils.safe_create(elt,::VertxShell::CliToken) }
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling line_tokens()"
  end
end

- (String) rawLine

Returns the current line being completed in raw format, i.e without any char escape performed

Returns:

  • (String)
    the current line being completed in raw format, i.e without any char escape performed


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

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

- (::VertxShell::Session) session

Returns the shell current session, useful for accessing data like the current path for file completion, etc...

Returns:

  • (::VertxShell::Session)
    the shell current session, useful for accessing data like the current path for file completion, etc...


50
51
52
53
54
55
56
57
58
59
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-shell/completion.rb', line 50

def session
  if !block_given?
    return ::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

- (::Vertx::Vertx) vertx

Returns the current Vert.x instance

Returns:



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/completion.rb', line 74

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