de.vandermeer.skb.interfaces.application

Interface ApoBase

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription

All Known Subinterfaces:

Apo_SimpleC, Apo_TypedC<T>, Apo_TypedCE<T>, Apo_TypedCP<T>, Apo_TypedCPE<T>, Apo_TypedE<T>, Apo_TypedP<T>, ApoBaseC, ApoBaseE, ApoBaseP, ApoBaseTyped<T>

public interface ApoBase
extends CategoryIs, HasDescription

Base for an application 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
String	getDisplayName() Returns the display name of the option.
default ST	getHelp() Returns help information for the option.
Object	getLongDescription() Returns a long description of the option.
boolean	isSet() Tests if the option is set.
default void	validate() Validates the option.

Methods inherited from interface HasDescription

getDescription

Method Detail

getHelp

default ST getHelp()

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.

Returns:

help information, must not be null

getLongDescription

Object getLongDescription()

Returns a long description of the option. For more complex options, the description should include use case and other information.

Returns:

long description for the option, blank if not set

isSet

boolean isSet()

Tests if the option is set.

Returns:

true if set, false otherwise

validate

default void validate()
               throws IllegalStateException

Validates the option.

Throws:

IllegalStateException - for any validation error

getDisplayName

String getDisplayName()

Returns the display name of the option.

Returns:

display name, must not be blank