de.vandermeer.skb.base.shell

Interface SkbShellArgument

All Superinterfaces:

CategoryHas, HasDescription

All Known Implementing Classes:

AbstractShellArgument

public interface SkbShellArgument
extends HasDescription

An argument for 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.
String	getKey() Returns the key of a shell argument.
SkbShellArgumentType	getType() Returns the type of a shell argument.
boolean	isOptional() Optional flag for the argument.
Object[]	valueSet() Returns an allowed set of values of same type as getType() refers to

Methods inherited from interface HasDescription

getDescription

Method Detail

getKey

String getKey()

Returns the key of a shell argument.

Returns:

shell argument key

getType

SkbShellArgumentType getType()

Returns the type of a shell argument.

Returns:

shell argument type

addedHelp

default String addedHelp()

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

Returns:

additional help text, null if none set

isOptional

boolean isOptional()

Optional flag for the argument.

Returns:

true if the argument is optional, false otherwise (default)

valueSet

Object[] valueSet()

Returns an allowed set of values of same type as getType() refers to

Returns:

value set, null if non specified (which means any value is allowed)