Package io.vertx.reactivex.ext.shell.cli
Class Completion
- java.lang.Object
-
- io.vertx.reactivex.ext.shell.cli.Completion
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<Completion>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description Completion(Completion delegate)
Completion(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
complete(String value, boolean terminal)
End the completion with a value that will be inserted to complete the line.void
complete(List<String> candidates)
End the completion with a list of candidates, these candidates will be displayed by the shell on the console.boolean
equals(Object o)
Completion
getDelegate()
int
hashCode()
List<CliToken>
lineTokens()
static Completion
newInstance(Completion arg)
String
rawLine()
Session
session()
String
toString()
Vertx
vertx()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<Completion> __TYPE_ARG
-
-
Constructor Detail
-
Completion
public Completion(Completion delegate)
-
Completion
public Completion(Object delegate)
-
-
Method Detail
-
getDelegate
public Completion getDelegate()
-
vertx
public Vertx vertx()
- Returns:
- the current Vert.x instance
-
session
public Session session()
- Returns:
- the shell current session, useful for accessing data like the current path for file completion, etc...
-
rawLine
public String rawLine()
- Returns:
- the current line being completed in raw format, i.e without any char escape performed
-
lineTokens
public List<CliToken> lineTokens()
- Returns:
- the current line being completed as preparsed tokens
-
complete
public void complete(List<String> candidates)
End the completion with a list of candidates, these candidates will be displayed by the shell on the console.- Parameters:
candidates
- the candidates
-
complete
public void complete(String value, boolean terminal)
End the completion with a value that will be inserted to complete the line.- Parameters:
value
- the value to complete withterminal
- true if the value is terminal, i.e can be further completed
-
newInstance
public static Completion newInstance(Completion arg)
-
-