info.informationsea.commandmanager.core

Interface ManagedCommand

All Known Implementing Classes:

CLICommandConsole.CLIBuiltinCommand, CLICommandConsole.CLIHelpCommand, CLICommandConsole.CLISourceCommand, LineEditorCommands.AbstractLineEditorCommand, LineEditorCommands.Convert, LineEditorCommands.Dummy, LineEditorCommands.Insert, LineEditorCommands.Load, LineEditorCommands.Print, LineEditorCommands.Replace, LineEditorCommands.Save

public interface ManagedCommand

A managed command. Classes implemented this interface should annotate parameters with args4j. CommandManager recognize the annotation, and prepare CLI or GUI for commands. CommandManager create an instance while creating complete database and completing. Please minimize constructor and setContext method to fast completing.

Method Summary

Modifier and Type	Method and Description
CommandResult	execute() Execute this command.
default java.util.List<java.lang.String>	getCandidateForArgument(int index) Get candidate values for an argument
default java.util.List<java.lang.String>	getCandidateForOption(java.lang.String name) Get candidate values for option `name`
default void	setContext(java.lang.Object context) Set a context object by CommandManager

Method Detail

execute

CommandResult execute()
               throws java.lang.Exception

Execute this command.

Returns:

Result

Throws:

java.lang.Exception - this command may throw Exception

setContext

default void setContext(java.lang.Object context)

Set a context object by CommandManager

Parameters:

context - a context object.

See Also:

CommandManager

getCandidateForOption

default java.util.List<java.lang.String> getCandidateForOption(java.lang.String name)

Get candidate values for option `name`

Parameters:

name - option name include '-'

Returns:

candidate values.

getCandidateForArgument

default java.util.List<java.lang.String> getCandidateForArgument(int index)

Get candidate values for an argument

Parameters:

index - an argument index

Returns:

candidate values.