de.vandermeer.skb.interfaces.application

Interface ApoBaseE

All Superinterfaces:

ApoBase, CategoryHas, CategoryIs, HasDescription

All Known Subinterfaces:

Apo_TypedCE<T>, Apo_TypedCPE<T>, Apo_TypedE<T>

public interface ApoBaseE
extends ApoBase

Base for an 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
String	getEnvironmentKey() Returns the environment key of the option.
default ST	getHelp() Returns help information for the option.
boolean	inEnvironment() Tests if the option was present in the environment.
default void	validate() Validates the option.

Methods inherited from interface ApoBase

getDisplayName, getLongDescription, isSet

Methods inherited from interface HasDescription

getDescription

Method Detail

getEnvironmentKey

String getEnvironmentKey()

Returns the environment key of the option.

Returns:

environment key, must not be blank

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

Returns:

help information, must not be null

inEnvironment

boolean inEnvironment()

Tests if the option was present in the environment.

Returns:

true if it was present, false otherwise

validate

default void validate()
               throws IllegalStateException

Description copied from interface: ApoBase

Validates the option.

Specified by:

validate in interface ApoBase

Throws:

IllegalStateException - for any validation error