A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

## A

args() - Method in CommandProcess
  @return
  Returns:
    the actual string arguments of the command
argsTokens() - Method in CommandProcess
  @return
  Returns:
    the unparsed arguments tokens

## B

build() - Method in CommandBuilder
  Build the command

## C

cli() - Method in Command
  @return
  Returns:
    the command line interface, can be null
CliToken - Class in io.vertx.groovy.ext.shell.cli
  A parsed token in the command line interface.
CliToken(Object) - Constructor in CliToken
Command - Class in io.vertx.groovy.ext.shell.command
  A Vert.x Shell command, it can be created from any language using the CommandBuilder.command or from a Java class using Command.create
Command(Object) - Constructor in Command
command(CLI) - Method in CommandBuilder
  Create a new commmand with its io.vertx.groovy.core.cli.CLI descriptor.
command() - Method in CommandRegistration
  Returns:
    the registered command.
CommandBuilder - Class in io.vertx.groovy.ext.shell.command
  A build for Vert.x Shell command.
CommandBuilder(Object) - Constructor in CommandBuilder
commandLine() - Method in CommandProcess
  @return
  Returns:
    the command line object or null
CommandProcess - Class in io.vertx.groovy.ext.shell.command
  The command process provides interaction with the process of the command provided by Vert.x Shell.
CommandProcess(Object) - Constructor in CommandProcess
CommandRegistration - Class in io.vertx.groovy.ext.shell.registry
  A registration of a command in the CommandRegistry
CommandRegistration(Object) - Constructor in CommandRegistration
CommandRegistry - Class in io.vertx.groovy.ext.shell.registry
  A registry that contains the commands known by a shell.
CommandRegistry(Object) - Constructor in CommandRegistry
complete(Completion) - Method in Command
  Perform command completion, when the command is done completing it should call or )} method to signal completion is done.
complete(Completion) - Method in CommandRegistration
  Complete the command for the given completion.
complete(Completion) - Method in CommandRegistry
  Perform completion, the completion argument will be notified of the completion progress.
complete(String, boolean) - Method in Completion
  End the completion with a value that will be inserted to complete the line.
Completion - Class in io.vertx.groovy.ext.shell.cli
  The completion object
Completion(Object) - Constructor in Completion
completionHandler(Handler<Completion>) - Method in CommandBuilder
  Set the command completion handler, the completion handler when the user asks for contextual command line completion, usually hitting the tab key.
create(Vertx, Map<String, Object>) - Method in ShellService
createBlank(String) - Method in CliToken
  Create a new blank token.
createProcess(List<CliToken>) - Method in CommandRegistration
  Create a new process with the passed arguments.
createProcess(List<CliToken>, Handler<AsyncResult<Process>>) - Method in CommandRegistry
  Try to create a process from the command line tokens.
createText(String) - Method in CliToken
  Create a text token.

## D

## E

end(int) - Method in CommandProcess
  End the process.
end(int) - Method in ProcessContext
  End the process.
eventHandler(EventType, Handler<Void>) - Method in CommandProcess
eventHandler(EventType, Handler<Void>) - Method in Tty
  Set an event handler to be notified by Shell events.
execute(ProcessContext) - Method in Process
  Execute the process in the given context.

## F

## G

get(Vertx) - Method in CommandRegistry
  Get the registry for the Vert.x instance
get(String) - Method in Session
  Get some data from the session
getCommandRegistry() - Method in ShellService
  @return
  Returns:
    the command registry for this service
getDelegate() - Method in CliToken
getDelegate() - Method in Command
getDelegate() - Method in CommandBuilder
getDelegate() - Method in CommandProcess
getDelegate() - Method in CommandRegistration
getDelegate() - Method in CommandRegistry
getDelegate() - Method in Completion
getDelegate() - Method in Process
getDelegate() - Method in ProcessContext
getDelegate() - Method in Session
getDelegate() - Method in ShellService
getDelegate() - Method in Stream
getDelegate() - Method in Tty

## H

height() - Method in Tty
  @return
  Returns:
    the current height, i.e the number of columns or if unknown

## I

isBlank() - Method in CliToken
  @return
  Returns:
    true when it's a blank token
isText() - Method in CliToken
  @return
  Returns:
    true when it's a text token

## J

## K

## L

lineTokens() - Method in Completion
  @return
  Returns:
    the current line being completed as preparsed tokens

## M

## N

name() - Method in Command
  @return
  Returns:
    the command name

## O

ofJson(Handler<Map<String, Object>>) - Method in Stream
ofString(Handler<String>) - Method in Stream

## P

Process - Class in io.vertx.groovy.ext.shell.process
  A process managed by the shell.
process(CommandProcess) - Method in Command
  Process the command, when the command is done processing it should call the CommandProcess.end method.
Process(Object) - Constructor in Process
ProcessContext - Class in io.vertx.groovy.ext.shell.process
  Allow a process to interact with its context during execution.
ProcessContext(Object) - Constructor in ProcessContext
processHandler(Handler<CommandProcess>) - Method in CommandBuilder
  Set the command process handler, the process handler is called when the command is executed.
put(String, Object) - Method in Session
  Put some data in a session

## Q

## R

raw() - Method in CliToken
  @return
  Returns:
    the raw token value, that may contain unescaped chars, for instance
rawLine() - Method in Completion
  @return
  Returns:
    the current line being completed in raw format, i.e without any char escape performed
registerCommand(Command, Handler<AsyncResult<CommandRegistration>>) - Method in CommandRegistry
registrations() - Method in CommandRegistry
  @return
  Returns:
    the current command registrations
remove(String) - Method in Session
  Remove some data from the session

## S

Session - Class in io.vertx.groovy.ext.shell
  A shell session.
session() - Method in CommandProcess
  @return
  Returns:
    the shell session
session() - Method in Completion
  Returns:
    the shell current session, useful for accessing data like the current path for file completion, etc...
session() - Method in ProcessContext
  @return
  Returns:
    the shell session
Session(Object) - Constructor in Session
setStdin(Stream) - Method in CommandProcess
setStdin(Handler<String>) - Method in Tty
  Set an handler the standard input to read the data in String format.
ShellService - Class in io.vertx.groovy.ext.shell
  The shell service, provides a remotely accessible shell available via Telnet or SSH according to the ShellService(Object) - Constructor in ShellService
start(Handler<AsyncResult<Void>>) - Method in ShellService
  Start the shell service, this is an asynchronous start.
stdout() - Method in Tty
  @return
  Returns:
    the standard output for emitting data
stop(Handler<AsyncResult<Void>>) - Method in ShellService
  Stop the shell service, this is an asynchronous start.
Stream - Class in io.vertx.groovy.ext.shell.io
  @author Julien Viet
Stream(Object) - Constructor in Stream

## T

tokenize(String) - Method in CliToken
  Tokenize the string argument and return a list of tokens.
Tty - Class in io.vertx.groovy.ext.shell.io
  Provide interactions with the Shell TTY.
tty() - Method in ProcessContext
  @return
  Returns:
    the tty assocated with this process
Tty(Object) - Constructor in Tty

## U

unregisterCommand(String, Handler<AsyncResult<Void>>) - Method in CommandRegistry

## V

value() - Method in CliToken
  @return
  Returns:
    the token value
vertx() - Method in CommandProcess
  @return
  Returns:
    the current Vert.x instance
vertx() - Method in Completion
  @return
  Returns:
    the current Vert.x instance

## W

width() - Method in Tty
  @return
  Returns:
    the current width, i.e the number of rows or if unknown
write(String) - Method in CommandProcess
write(Map<String, Object>) - Method in Stream

## X

## Y

## Z

## _

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _