Package io.vertx.ext.shell.command
Class AnnotatedCommand
- java.lang.Object
-
- io.vertx.ext.shell.command.AnnotatedCommand
-
- Direct Known Subclasses:
BusPublish,BusTail,Echo,FileSystemCd,FileSystemLs,FileSystemPwd,Help,LocalMapGet,LocalMapPut,LocalMapRm,NetCommandLs,Sleep,VerticleDeploy,VerticleFactories,VerticleLs,VerticleUndeploy
public abstract class AnnotatedCommand extends Object
The base command class that Java annotated command should extend.- Author:
- Julien Viet
-
-
Constructor Summary
Constructors Constructor Description AnnotatedCommand()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description CLIcli()voidcomplete(Completion completion)Perform command completion, when the command is done completing it should callCompletion.complete(List)orCompletion.complete(String, boolean))} method to signal completion is done.Stringname()abstract voidprocess(CommandProcess process)Process the command, when the command is done processing it should call theCommandProcess.end()method.
-
-
-
Method Detail
-
name
public String name()
- Returns:
- the command name
-
cli
public CLI cli()
- Returns:
- the command line interface, can be null
-
process
public abstract void process(CommandProcess process)
Process the command, when the command is done processing it should call theCommandProcess.end()method.- Parameters:
process- the command process
-
complete
public void complete(Completion completion)
Perform command completion, when the command is done completing it should callCompletion.complete(List)orCompletion.complete(String, boolean))} method to signal completion is done.- Parameters:
completion- the completion object
-
-