de.vandermeer.skb.interfaces.application

Interface Apo_TypedP<T>

All Superinterfaces:

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

All Known Subinterfaces:

Apo_TypedCP<T>, Apo_TypedCPE<T>

public interface Apo_TypedP<T>
extends ApoBaseP, ApoBaseTyped<T>

A standard typed property 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
default ST	getHelp() Returns help information for the option.
T	getPropertyValue() Returns the property value of the option if any set.
default T	getValue() Returns the value of the option.
default boolean	isSet() Tests if the option is set.
void	setPropertyValue(Properties properties) Sets the property value of the option.

Methods inherited from interface ApoBaseP

getPropertyKey, inProperties, validate

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 ApoBase

Specified by:

getHelp in interface ApoBaseP

Returns:

help information, must not be null

getPropertyValue

T getPropertyValue()

Returns the property value of the option if any set.

Returns:

property value, null if none set

getValue

default T getValue()

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

setPropertyValue

void setPropertyValue(Properties properties)
               throws IllegalStateException

Sets the property value of the option.

Parameters:

properties - set of properties to get the value from

Throws:

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