de.vandermeer.skb.base.shell

Class AbstractShellArgument

Object

AbstractShellArgument

All Implemented Interfaces:

SkbShellArgument, CategoryHas, HasDescription

public class AbstractShellArgument
extends Object
implements SkbShellArgument

An abstract, default implementation of a shell argument, 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.
String	getDescription()
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.
String	toString()
Object[]	valueSet() Returns an allowed set of values of same type as SkbShellArgument.getType() refers to

Methods inherited from class Object

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

Method Detail

getKey

public String getKey()

Description copied from interface: SkbShellArgument

Returns the key of a shell argument.

Specified by:

getKey in interface SkbShellArgument

Returns:

shell argument key

getType

public SkbShellArgumentType getType()

Description copied from interface: SkbShellArgument

Returns the type of a shell argument.

Specified by:

getType in interface SkbShellArgument

Returns:

shell argument type

getDescription

public String getDescription()

Specified by:

getDescription in interface HasDescription

addedHelp

public String addedHelp()

Description copied from interface: SkbShellArgument

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

Specified by:

addedHelp in interface SkbShellArgument

Returns:

additional help text, null if none set

isOptional

public boolean isOptional()

Description copied from interface: SkbShellArgument

Optional flag for the argument.

Specified by:

isOptional in interface SkbShellArgument

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

valueSet

public Object[] valueSet()

Description copied from interface: SkbShellArgument

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

Specified by:

valueSet in interface SkbShellArgument

Returns:

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