Top Description Fields Constructors Methods
com.headius.options

public Class BooleanOption

extends Option<Boolean>
Class Inheritance
A Boolean-based Option. Unlike the other options, if a boolean property is specified but is blank, it is considered an "on" switch and a true value.

Field Summary

Inherited from com.headius.options.Option:
defvaltype

Constructor Summary

AccessConstructor and Description
public
BooleanOption(String prefix, String shortName, Enum<E extends Enum<E>> category, Boolean defval, String description)

public
BooleanOption(String longName, Enum<E extends Enum<E>> category, Boolean defval, String description)

Method Summary

Modifier and TypeMethod and Description
protected Boolean
reloadValue()

Implements abstract com.headius.options.Option.reloadValue.

Perform the appropriate load and conversion for the option's property.
Inherited from com.headius.options.Option:
boolboolboolbooldefaultValuedescriptiondisplayNameenumerationenumerationenumerationenumerationforceformatOptionsformatOptionsformatValuesformatValuesintegerintegerintegerintegerintegerintegerintegerintegerisSpecifiedloadloadPropertyoptionsprefixpropertyNamereloadshortNamestringstringstringstringstringstringstringstringtoStringtypeunforce

Constructor Detail

BooleanOptionback to summary
public BooleanOption(String prefix, String shortName, Enum<E extends Enum<E>> category, Boolean defval, String description)
BooleanOptionback to summary
public BooleanOption(String longName, Enum<E extends Enum<E>> category, Boolean defval, String description)

Method Detail

reloadValueback to summary
protected Boolean reloadValue()

Implements abstract com.headius.options.Option.reloadValue.

Doc from com.headius.options.Option.reloadValue.

Perform the appropriate load and conversion for the option's property.

Returns:Boolean

the updated value after reload