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

Class ModulePreference

java.lang.Object

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

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

org.openwms.core.preferences.impl.file.ModulePreference

All Implemented Interfaces:

Serializable

public class ModulePreference
extends GenericPreference
implements Serializable

A ModulePreference is used to store configuration settings in Module scope.

The table model of an ModulePreference spans an unique key over the columns C_TYPE, C_OWNER and C_KEY.

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

Author:

Heiko Scherrer

See Also:

• Serialized Form

Field Summary

Fields

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

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

description, maximum, minimum, type, value

Constructor Summary

Constructors

Constructor	Description
ModulePreference()	Create a new ModulePreference.
ModulePreference(String owner, String key)	Create a new ModulePreference.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected Object[]	getFields()	Return all fields as an array of objects.
String	getKey()	Get the key.
String	getOwner()	Get the owner.
PreferenceKey	getPrefKey()	Return a PreferenceKey of this preference.
int	hashCode()
void	setKey(String key)
void	setOwner(String owner)
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

owner

private String owner

Owner of the ModulePreference (not nullable).

key

private String key

Key of the ModulePreference (not nullable).

Constructor Details

ModulePreference

public ModulePreference()

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

ModulePreference

public ModulePreference(String owner,
 String key)

Create a new ModulePreference.

Parameters:

owner - The name of the owning module

key - the key

Throws:

IllegalArgumentException - when key or owner is null or empty

Method Details

getKey

public String getKey()

Get the key.

Returns:

the key

setKey

public void setKey(String key)

getOwner

public String getOwner()

Get the owner.

Returns:

the owner

setOwner

public void setOwner(String owner)

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, owner and the key to create a PreferenceKey instance.

Specified by:

getPrefKey in class AbstractPreference

Returns:

A PreferenceKey

hashCode

public int hashCode()

Uses the type, owner and the key for the hashCode calculation.

Overrides:

hashCode in class GenericPreference

equals

public boolean equals(Object obj)

Comparison done with the type, owner and the key fields. Not delegated to super class.

Overrides:

equals in class GenericPreference

toString

public String toString()

Use all fields.

Overrides:

toString in class GenericPreference