de.vandermeer.skb.base.shell

Class AbstractShellCommand

Object

AbstractShellCommand

All Implemented Interfaces:

SkbShellCommand, CategoryHas, HasDescription

public class AbstractShellCommand
extends Object
implements SkbShellCommand

An abstract, default implementation of a shell command, use the SkbShellFactory to create a new object.

Since:

v0.0.10

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields inherited from interface HasDescription

DEFAULT_DESCRIPTION

Method Summary

Modifier and Type	Method and Description
String	addedHelp() Returns additional text for an auto-generated help for the argument.
SkbShellArgument[]	getArguments() Returns the arguments of this command.
SkbShellCommandCategory	getCategory() Returns a category the command belongs to, useful for grouping commands for example in help screens.
String	getCommand() Returns the shell command.
String	getDescription()
String	toString()

Methods inherited from class Object

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

Method Detail

getCommand

public String getCommand()

Description copied from interface: SkbShellCommand

Returns the shell command.

Specified by:

getCommand in interface SkbShellCommand

Returns:

shell commands

getArguments

public SkbShellArgument[] getArguments()

Description copied from interface: SkbShellCommand

Returns the arguments of this command.

Specified by:

getArguments in interface SkbShellCommand

Returns:

command arguments

getDescription

public String getDescription()

Specified by:

getDescription in interface HasDescription

getCategory

public SkbShellCommandCategory getCategory()

Description copied from interface: SkbShellCommand

Returns a category the command belongs to, useful for grouping commands for example in help screens.

Specified by:

getCategory in interface SkbShellCommand

Returns:

the category of the command, can be null

addedHelp

public String addedHelp()

Description copied from interface: SkbShellCommand

Returns additional text for an auto-generated help for the argument.

Specified by:

addedHelp in interface SkbShellCommand

Returns:

additional help text, null if none set

toString

public String toString()

Overrides:

toString in class Object