Package jadex.platform.service.cli

Interface ICliCommand

All Known Implementing Classes:

ACliCommand, AddResourceCommand, ChangeDirectoryCommand, CreateComponentCommand, DestroyComponentCommand, DownloadFileCommand, EvaluateExpressionCommand, ExecuteFileCommand, HelpCommand, JCCCommand, KillPlatformCommand, ListComponentsCommand, ListDirectoryCommand, ListPlatformsCommand, MakeDirectoryCommand, RemoveFileCommand, SaveSettingsCommand, ServiceQueryCommand, SetSecretCommand, ShowPlatformArgumentsCommand, SwitchPlatformCommand, UploadFileCommand

public interface ICliCommand

The command line command interface.

Method Summary

Modifier and Type	Method	Description
ArgumentInfo[]	getArgumentInfos(CliContext context)	Get the argument info.
java.lang.String	getDescription()	Get the command description.
java.lang.String	getExampleUsage()	Get example usage(s).
java.lang.String[]	getNames()	Get the command names (name including alias').
ResultInfo	getResultInfo(CliContext context, java.util.Map<java.lang.String,java.lang.Object> args)	Get the result info.
IFuture<java.lang.String>	invokeCommand(CliContext context, java.lang.String[] args)	Invoke the command.
java.lang.Object	invokeCommand(CliContext context, java.util.Map<java.lang.String,java.lang.Object> args)	Invoke the command.

Method Detail

getNames

java.lang.String[] getNames()

Get the command names (name including alias').

Returns:

A string array of the command name and optional further alias names.

getDescription

java.lang.String getDescription()

Get the command description.

Returns:

The command description.

getExampleUsage

java.lang.String getExampleUsage()

Get example usage(s).

Returns:

Example usages.

getArgumentInfos

ArgumentInfo[] getArgumentInfos(CliContext context)

Get the argument info.

Parameters:

context - The context.

Returns:

The argument infos.

getResultInfo

ResultInfo getResultInfo(CliContext context,
                         java.util.Map<java.lang.String,java.lang.Object> args)

Get the result info.

Parameters:

context - The context.

Returns:

The result info.

invokeCommand

java.lang.Object invokeCommand(CliContext context,
                               java.util.Map<java.lang.String,java.lang.Object> args)

Invoke the command.

Parameters:

context - The context.

args - The arguments.

invokeCommand

IFuture<java.lang.String> invokeCommand(CliContext context,
                                        java.lang.String[] args)

Invoke the command.

Parameters:

context - The context.

args - The arguments.