de.vandermeer.skb.interfaces.application

Interface ApoBaseP

All Superinterfaces:

ApoBase, CategoryHas, CategoryIs, HasDescription

All Known Subinterfaces:

Apo_TypedCP<T>, Apo_TypedCPE<T>, Apo_TypedP<T>

public interface ApoBaseP
extends ApoBase

Base for a property 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 ST	getHelp() Returns help information for the option.
String	getPropertyKey() Returns the property key of the option.
boolean	inProperties() Tests if the option was present in properties.
default void	validate() Validates the option.

Methods inherited from interface ApoBase

getDisplayName, getLongDescription, isSet

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

Returns:

help information, must not be null

getPropertyKey

String getPropertyKey()

Returns the property key of the option.

Returns:

property key, must not be blank

inProperties

boolean inProperties()

Tests if the option was present in properties.

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