de.vandermeer.skb.interfaces.application

Interface Apo_TypedE<T>

All Superinterfaces:

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

All Known Subinterfaces:

Apo_TypedCE<T>, Apo_TypedCPE<T>

public interface Apo_TypedE<T>
extends ApoBaseE, ApoBaseTyped<T>

A standard typed environment options.

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
T	getEnvironmentValue() Returns the environment 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.

Methods inherited from interface ApoBaseE

getEnvironmentKey, inEnvironment, validate

Methods inherited from interface ApoBaseTyped

getDefaultValue

Methods inherited from interface ApoBase

getDisplayName, getLongDescription

Methods inherited from interface HasDescription

getDescription

Method Detail

getEnvironmentValue

T getEnvironmentValue()

Returns the environment value of the option if any set.

Returns:

environment 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 ApoBaseE

Returns:

help information, must not be null

getValue

default T getValue()

Returns the value of the option. First the environment 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