de.vandermeer.skb.interfaces.application

Interface Apo_TypedC<T>

All Superinterfaces:

ApoBase, ApoBaseC, ApoBaseTyped<T>, CategoryHas, CategoryIs, HasDescription

All Known Subinterfaces:

Apo_TypedCE<T>, Apo_TypedCP<T>, Apo_TypedCPE<T>

public interface Apo_TypedC<T>
extends ApoBaseTyped<T>, ApoBaseC

A standard typed CLI option.

Since:

v0.0.2

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

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

Method Summary

Modifier and Type	Method and Description
default boolean	cliArgIsOptional() Returns the flag for an argument being optional or not.
String	getCliArgumentDescription() Returns a description of the CLI argument.
String	getCliArgumentName() Returns the name of the CLI argument.
T	getCliValue() Returns the CLI value of the option if any set.
default ST	getHelp() Returns help information for the option.
default T	getValue() Returns the value of the option.
default boolean	isSet() Tests if the option is set.
void	setCliValue(Object value) Sets the CLI value of the option.
default void	validate() Validates the option.

Methods inherited from interface ApoBaseTyped

getDefaultValue

Methods inherited from interface ApoBaseC

cliIsRequired, getCliLong, getCliShort, getCliShortLong, inCli, setInCLi

Methods inherited from interface ApoBase

getDisplayName, getLongDescription

Methods inherited from interface HasDescription

getDescription

Method Detail

cliArgIsOptional

default boolean cliArgIsOptional()

Returns the flag for an argument being optional or not. The default implementation is false.

Returns:

true if argument is optional, false if not.

getCliArgumentDescription

String getCliArgumentDescription()

Returns a description of the CLI argument. The CLI argument is the value that is expected with in the command line. For instance, if the option is -h COMMAD there is a argument COMMAND expected from the command line. This description then should explain what COMMAD is or what values can be used.

Returns:

CLI argument description, must not be blank

getCliArgumentName

String getCliArgumentName()

Returns the name of the CLI argument. For instance, if the option is -h COMMAD there is a argument COMMAND expected from the command line. The name returned in this example should be COMMAND.

Returns:

CLI argument name, must not be blank

getCliValue

T getCliValue()

Returns the CLI value of the option if any set.

Returns:

CLI value, null if none set

getHelp

default ST getHelp()

Description copied from interface: ApoBase

Returns help information for the option. The information contains all possible settings, except the long description. This might include CLI, property, environment, and other settings.

Specified by:

getHelp in interface ApoBase

Specified by:

getHelp in interface ApoBaseC

Returns:

help information, must not be null

getValue

default T getValue()

Returns the value of the option. First the CLI value is tested and if not null it is returned. Last the default value is returned.

Specified by:

getValue in interface ApoBaseTyped<T>

Returns:

application value, null if none found

isSet

default boolean isSet()

Tests if the option is set. A typed option is set if it has a value that is not null.

Specified by:

isSet in interface ApoBase

Specified by:

isSet in interface ApoBaseTyped<T>

Returns:

true if set, false otherwise

setCliValue

void setCliValue(Object value)
          throws CliParseException,
                 IllegalStateException

Sets the CLI value of the option.

Parameters:

value - the value read from the command line, must not be null (or blank in case of a string)

Throws:

CliParseException - if the argument was blank (string) or otherwise problematic

IllegalStateException - if the argument was blank (string) or otherwise problematic

validate

default void validate()
               throws IllegalStateException

Description copied from interface: ApoBase

Validates the option.

Specified by:

validate in interface ApoBase

Specified by:

validate in interface ApoBaseC

Throws:

IllegalStateException - for any validation error