Package org.openwms.core.preferences.impl.file

Class ApplicationPreference

java.lang.Object

org.openwms.core.preferences.impl.file.AbstractPreference

org.openwms.core.preferences.impl.file.GenericPreference

org.openwms.core.preferences.impl.file.ApplicationPreference

All Implemented Interfaces:

Serializable

public class ApplicationPreference
extends GenericPreference
implements Serializable

An ApplicationPreference is used to store a configuration setting in application scope.

The table model of an ApplicationPreference spans an unique key over the columns C_TYPE and C_KEY.

It's counterpart in the context of JAXB is the applicationPreference element.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ApplicationPreference.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private String	key	Key of the preference (not nullable).

Fields inherited from class org.openwms.core.preferences.impl.file.GenericPreference

description, maximum, minimum, type, value

Constructor Summary

Constructors

Modifier	Constructor	Description
	ApplicationPreference()	Create a new ApplicationPreference.
	ApplicationPreference(String key)	Create a new ApplicationPreference.
private	ApplicationPreference(ApplicationPreference.Builder builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
protected Object[]	getFields()	Return all fields as an array of objects.
String	getKey()	Get the key.
PreferenceKey	getPrefKey()	Return a PreferenceKey of this preference.
int	hashCode()
void	setKey(String key)
String	toString()

Methods inherited from class org.openwms.core.preferences.impl.file.GenericPreference

getDescription, getMaximum, getMinimum, getType, getValue, setDescription, setMaximum, setMinimum, setType, setValue

Methods inherited from class java.lang.Object

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

Field Details

key

private String key

Key of the preference (not nullable).

Constructor Details

ApplicationPreference

public ApplicationPreference()

Create a new ApplicationPreference. Only defined by the JAXB implementation.

ApplicationPreference

public ApplicationPreference(String key)

Create a new ApplicationPreference.

Parameters:

key - the key

Throws:

IllegalArgumentException - when key is null or empty

ApplicationPreference

private ApplicationPreference(ApplicationPreference.Builder builder)

Method Details

getKey

public String getKey()

Get the key.

Returns:

the key

setKey

public void setKey(String key)

getFields

protected Object[] getFields()

Return all fields as an array of objects.

Specified by:

getFields in class AbstractPreference

Returns:

fields as array

getPrefKey

public PreferenceKey getPrefKey()

Return a PreferenceKey of this preference.

Uses the type and key to create a PreferenceKey instance.

Specified by:

getPrefKey in class AbstractPreference

Returns:

A PreferenceKey

See Also:

• AbstractPreference.getPrefKey()

equals

public boolean equals(Object o)

Overrides:

equals in class GenericPreference

hashCode

public int hashCode()

Overrides:

hashCode in class GenericPreference

toString

public String toString()

Overrides:

toString in class GenericPreference