org.n52.faroe

Class AbstractSettingDefinition<T>

java.lang.Object

org.n52.faroe.AbstractOrdered

org.n52.faroe.AbstractSettingDefinition<T>

Type Parameters:

T - the type of the value

All Implemented Interfaces:

Serializable, Comparable<Ordered>, Ordered, SettingDefinition<T>

Direct Known Subclasses:

BooleanSettingDefinition, ChoiceSettingDefinition, DateTimeSettingDefinition, FileSettingDefinition, IntegerSettingDefinition, MultilingualStringSettingDefinition, NumericSettingDefinition, StringSettingDefinition, UriSettingDefinition

public abstract class AbstractSettingDefinition<T>
extends AbstractOrdered
implements SettingDefinition<T>, Serializable

Generic implementation of SettingDefinition.

Since:

1.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSettingDefinition(SettingType type)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
T	getDefaultValue()
String	getDescription()
SettingDefinitionGroup	getGroup()
String	getKey()
protected String	getSuborder()
String	getTitle()
SettingType	getType()
boolean	hasDefaultValue()
boolean	hasDescription()
boolean	hasGroup()
int	hashCode()
protected boolean	hasStringProperty(String s)
boolean	hasTitle()
boolean	isOptional()
AbstractSettingDefinition<T>	setDefaultValue(T d) Sets the default value of this setting.
AbstractSettingDefinition<T>	setDescription(String d) Sets the description of this setting definition, which should further describe the purpose of this setting.
AbstractSettingDefinition<T>	setGroup(SettingDefinitionGroup g) Sets the group of this definition.
AbstractSettingDefinition<T>	setKey(String k) Sets the unique identifier of this setting definition, which can be referenced by configurable classes.
AbstractSettingDefinition<T>	setOptional(boolean o) Sets whether this setting is optional or can be null.
AbstractSettingDefinition<T>	setTitle(String t) Sets the title of this setting definition, which will be presented to the user.
(package private) AbstractSettingDefinition<T>	setType(SettingType type)
String	toString()

Methods inherited from class org.n52.faroe.AbstractOrdered

compareTo, getOrder, setOrder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.n52.faroe.SettingDefinition

getGroup, getOptionalDefaultValue

Methods inherited from interface org.n52.faroe.Ordered

getOrder, setOrder

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

AbstractSettingDefinition

protected AbstractSettingDefinition(SettingType type)

Parameters:

type - the SettingType of this setting definition

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SettingDefinition<T>

Returns:

the unique key of this definition

setKey

public AbstractSettingDefinition<T> setKey(String k)

Description copied from interface: SettingDefinition

Sets the unique identifier of this setting definition, which can be referenced by configurable classes.

Specified by:

setKey in interface SettingDefinition<T>

Parameters:

k - the unique key

getDescription

public String getDescription()

Specified by:

getDescription in interface SettingDefinition<T>

Returns:

the description of this definition

setDescription

public AbstractSettingDefinition<T> setDescription(String d)

Description copied from interface: SettingDefinition

Sets the description of this setting definition, which should further describe the purpose of this setting. Can contain XHTML markup.

Specified by:

setDescription in interface SettingDefinition<T>

Parameters:

d - the description

hasDescription

public boolean hasDescription()

Specified by:

hasDescription in interface SettingDefinition<T>

Returns:

if this definition has a non empty description

getTitle

public String getTitle()

Specified by:

getTitle in interface SettingDefinition<T>

Returns:

the title of this definition

setTitle

public AbstractSettingDefinition<T> setTitle(String t)

Description copied from interface: SettingDefinition

Sets the title of this setting definition, which will be presented to the user.

Specified by:

setTitle in interface SettingDefinition<T>

Parameters:

t - the title

hasTitle

public boolean hasTitle()

Specified by:

hasTitle in interface SettingDefinition<T>

Returns:

if this definition has a non empty title

isOptional

public boolean isOptional()

Specified by:

isOptional in interface SettingDefinition<T>

Returns:

wether this setting is optional or required.

setOptional

public AbstractSettingDefinition<T> setOptional(boolean o)

Description copied from interface: SettingDefinition

Sets whether this setting is optional or can be null. By default all settings are required.

Specified by:

setOptional in interface SettingDefinition<T>

Parameters:

o - if this setting is optional

getGroup

public SettingDefinitionGroup getGroup()

Specified by:

getGroup in interface SettingDefinition<T>

Returns:

the group of this definition

setGroup

public AbstractSettingDefinition<T> setGroup(SettingDefinitionGroup g)

Description copied from interface: SettingDefinition

Sets the group of this definition. If no group is set, the setting will be moved to a default group.

Specified by:

setGroup in interface SettingDefinition<T>

Parameters:

g - the group

hasGroup

public boolean hasGroup()

Specified by:

hasGroup in interface SettingDefinition<T>

Returns:

if this definition has a group

getDefaultValue

public T getDefaultValue()

Specified by:

getDefaultValue in interface SettingDefinition<T>

Returns:

the default value (or null if there is none)

setDefaultValue

public AbstractSettingDefinition<T> setDefaultValue(T d)

Description copied from interface: SettingDefinition

Sets the default value of this setting. All required settings should have a default setting to allow a smoother integration of new settings in old configurations.

Specified by:

setDefaultValue in interface SettingDefinition<T>

Parameters:

d - the default value

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface SettingDefinition<T>

Returns:

if this definition has a default value

hasStringProperty

protected boolean hasStringProperty(String s)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractOrdered

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractOrdered

toString

public String toString()

Overrides:

toString in class Object

getType

public SettingType getType()

Specified by:

getType in interface SettingDefinition<T>

Returns:

the type of the value of this definition

setType

AbstractSettingDefinition<T> setType(SettingType type)

getSuborder

protected String getSuborder()

Specified by:

getSuborder in class AbstractOrdered