Package jadex.platform.service.cli.commands

Class HelpCommand

java.lang.Object

jadex.platform.service.cli.ACliCommand

jadex.platform.service.cli.commands.HelpCommand

All Implemented Interfaces:

ICliCommand

public class HelpCommand
extends ACliCommand

The help command can be used to display all available or a specific command.

Constructor Summary

Constructors

Constructor	Description
HelpCommand()

Method Summary

Modifier and Type	Method	Description
ArgumentInfo[]	getArgumentInfos(CliContext context)	Get the argument types.
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.
protected java.lang.String	getShortCommandInfo(ICliCommand cmd)	Get a short command info.
java.lang.Object	invokeCommand(CliContext context, java.util.Map<java.lang.String,java.lang.Object> args)	Invoke the command.

Methods inherited from class jadex.platform.service.cli.ACliCommand

invokeCommand

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HelpCommand

public HelpCommand()

Method Detail

getNames

public java.lang.String[] getNames()

Get the command names (name including alias').

Specified by:

getNames in interface ICliCommand

Specified by:

getNames in class ACliCommand

Returns:

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

getDescription

public java.lang.String getDescription()

Get the command description.

Specified by:

getDescription in interface ICliCommand

Overrides:

getDescription in class ACliCommand

Returns:

The command description.

getExampleUsage

public java.lang.String getExampleUsage()

Get example usage(s).

Specified by:

getExampleUsage in interface ICliCommand

Overrides:

getExampleUsage in class ACliCommand

Returns:

Example usages.

getArgumentInfos

public ArgumentInfo[] getArgumentInfos(CliContext context)

Get the argument types.

Specified by:

getArgumentInfos in interface ICliCommand

Overrides:

getArgumentInfos in class ACliCommand

Parameters:

context - The context.

Returns:

The argument infos.

invokeCommand

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

Invoke the command.

Specified by:

invokeCommand in interface ICliCommand

Specified by:

invokeCommand in class ACliCommand

Parameters:

context - The context.

args - The arguments.

getResultInfo

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

Get the result info.

Specified by:

getResultInfo in interface ICliCommand

Overrides:

getResultInfo in class ACliCommand

Parameters:

context - The context.

Returns:

The result info.

getShortCommandInfo

protected java.lang.String getShortCommandInfo(ICliCommand cmd)

Get a short command info.

Parameters:

cmd - The command.