de.vandermeer.skb.interfaces.application

Interface Apo_TypedCPE<T>

All Superinterfaces:

Apo_TypedC<T>, Apo_TypedE<T>, Apo_TypedP<T>, ApoBase, ApoBaseC, ApoBaseE, ApoBaseP, ApoBaseTyped<T>, CategoryHas, CategoryIs, HasDescription

public interface Apo_TypedCPE<T>
extends Apo_TypedC<T>, Apo_TypedP<T>, Apo_TypedE<T>

A standard typed option that combines CLI, property, and environment settings.

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 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.
default void	validate() Validates the option.

Methods inherited from interface Apo_TypedC

cliArgIsOptional, getCliArgumentDescription, getCliArgumentName, getCliValue, setCliValue

Methods inherited from interface ApoBaseC

cliIsRequired, getCliLong, getCliShort, getCliShortLong, inCli, setInCLi

Methods inherited from interface Apo_TypedP

getPropertyValue, setPropertyValue

Methods inherited from interface ApoBaseP

getPropertyKey, inProperties

Methods inherited from interface Apo_TypedE

getEnvironmentValue

Methods inherited from interface ApoBaseE

getEnvironmentKey, inEnvironment

Methods inherited from interface ApoBaseTyped

getDefaultValue

Methods inherited from interface ApoBase

getDisplayName, getLongDescription

Methods inherited from interface HasDescription

getDescription

Method Detail

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 Apo_TypedC<T>

Specified by:

getHelp in interface Apo_TypedE<T>

Specified by:

getHelp in interface Apo_TypedP<T>

Specified by:

getHelp in interface ApoBase

Specified by:

getHelp in interface ApoBaseC

Specified by:

getHelp in interface ApoBaseE

Specified by:

getHelp in interface ApoBaseP

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. Second, the property value is tested and if not it is returned. Third, the environment value is tested and if not it is returned. Last the default value is returned.

Specified by:

getValue in interface Apo_TypedC<T>

Specified by:

getValue in interface Apo_TypedE<T>

Specified by:

getValue in interface Apo_TypedP<T>

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 Apo_TypedC<T>

Specified by:

isSet in interface Apo_TypedE<T>

Specified by:

isSet in interface Apo_TypedP<T>

Specified by:

isSet in interface ApoBase

Specified by:

isSet in interface ApoBaseTyped<T>

Returns:

true if set, false otherwise

validate

default void validate()
               throws IllegalStateException

Description copied from interface: ApoBase

Validates the option.

Specified by:

validate in interface Apo_TypedC<T>

Specified by:

validate in interface ApoBase

Specified by:

validate in interface ApoBaseC

Specified by:

validate in interface ApoBaseE

Specified by:

validate in interface ApoBaseP

Throws:

IllegalStateException - for any validation error