de.vandermeer.skb.base.shell

Interface SkbShellCommand

All Superinterfaces:

CategoryHas, HasDescription

All Known Implementing Classes:

AbstractShellCommand

public interface SkbShellCommand
extends HasDescription

A command for the SkbShell.

Since:

v0.0.8

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
default 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.

Methods inherited from interface HasDescription

getDescription

Method Detail

getCommand

String getCommand()

Returns the shell command.

Returns:

shell commands

getCategory

SkbShellCommandCategory getCategory()

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

Returns:

the category of the command, can be null

getArguments

SkbShellArgument[] getArguments()

Returns the arguments of this command.

Returns:

command arguments

addedHelp

default String addedHelp()

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

Returns:

additional help text, null if none set