de.weltraumschaf.commons.shell

Class ShellCommand

java.lang.Object

de.weltraumschaf.commons.shell.ShellCommand

public class ShellCommand
extends Object

Describes a parsed mainCommand of the interactive shell.

Commands consist always of a mainCommand and may have a subcommand. This type is immutable.

Since:

1.0.0

Author:

Sven Strittmatter

Field Summary

Fields

Modifier and Type	Field and Description
private List<Token>	arguments Optional arguments.
private MainCommandType	mainCommand Obligatory main command.
private SubCommandType	subCommand Optional sub mainCommand.

Constructor Summary

Constructors

Constructor and Description
ShellCommand(MainCommandType mainCommand, SubCommandType subCommand, List<Token> arguments) Dedicated constructor.

Method Summary

Methods

Modifier and Type	Method and Description
List<Token>	getArguments() Get arguments.
MainCommandType	getMainCommand() Get mainCommand main type.
SubCommandType	getSubCommand() Get optional mainCommand sub type.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

mainCommand

private final MainCommandType mainCommand

Obligatory main command.

subCommand

private final SubCommandType subCommand

Optional sub mainCommand. If the shell mainCommand does not support sub commands this will be the value of LiteralCommandMap.getDefaultSubCommand().

arguments

private final List<Token> arguments

Optional arguments. If the mainCommand has no arguments this will be an empty list.

Constructor Detail

ShellCommand

public ShellCommand(MainCommandType mainCommand,
            SubCommandType subCommand,
            List<Token> arguments)

Dedicated constructor.

Parameters:

mainCommand - must not be null

subCommand - must not be null

arguments - must not be null, may be an empty list

Method Detail

getMainCommand

public MainCommandType getMainCommand()

Get mainCommand main type.

Returns:

main type of mainCommand

getSubCommand

public SubCommandType getSubCommand()

Get optional mainCommand sub type. If the main type does not support any sub type the same value as LiteralCommandMap.getDefaultSubCommand() will be returned.

Returns:

sub type of mainCommand

getArguments

public List<Token> getArguments()

Get arguments. This method will always return a list. If no arguments are present an empty list will be returned.

Returns:

Returns a defense copy.

toString

public String toString()

Overrides:

toString in class Object