Package com.avanza.astrix.config

Class BooleanSetting

java.lang.Object

com.avanza.astrix.config.BooleanSetting

All Implemented Interfaces:

Setting<Boolean>

public class BooleanSetting
extends Object
implements Setting<Boolean>

A Setting of boolean type, see Setting

Author:

"Elias Lindholm"

Method Summary

Modifier and Type	Method	Description
static BooleanSetting	create(String name, boolean defaultValue)
Boolean	defaultValue()	The default value for this setting.
DynamicBooleanProperty	getFrom(DynamicConfig config)	Reads this Setting from the given DynamicConfig instance.
String	name()	The name of this Setting.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static BooleanSetting create(String name,
                                    boolean defaultValue)

getFrom

public DynamicBooleanProperty getFrom(DynamicConfig config)

Description copied from interface: Setting

Reads this Setting from the given DynamicConfig instance. If the DynamicConfig instance does not hold a value for this Setting, then the default value will be returned.

Specified by:

getFrom in interface Setting<Boolean>

Parameters:

config - DynamicConfig instance to read this setting from

Returns:

This value of this setting in the given DynamicConfig instance, or the default value if the DynamicConfig instance does not contain a value for this Setting

name

public String name()

Description copied from interface: Setting

The name of this Setting. Used when reading this Setting from a DynamicConfig instance.

Specified by:

name in interface Setting<Boolean>

defaultValue

public Boolean defaultValue()

Description copied from interface: Setting

The default value for this setting. For settings of primitive types this method returns the boxed version of the given type, and never returns null.

Specified by:

defaultValue in interface Setting<Boolean>