Package com.avanza.astrix.config

Class StringSetting

java.lang.Object

com.avanza.astrix.config.StringSetting

All Implemented Interfaces:

Setting<String>

public class StringSetting
extends Object
implements Setting<String>

A Setting of String type, see Setting

Author:

"Elias Lindholm"

Constructor Summary

Constructors

Constructor	Description
StringSetting(String name, String defaultValue)

Method Summary

Modifier and Type	Method	Description
static StringSetting	create(String name, String defaultValue)
String	defaultValue()	The default value for this setting.
DynamicStringProperty	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

Constructor Detail

StringSetting

public StringSetting(String name,
                     String defaultValue)

Method Detail

create

public static StringSetting create(String name,
                                   String defaultValue)

getFrom

public DynamicStringProperty 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<String>

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<String>

defaultValue

public String 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<String>