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

Class UserPreference

java.lang.Object

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

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

org.openwms.core.preferences.impl.file.UserPreference

All Implemented Interfaces:

Serializable

public class UserPreference
extends GenericPreference
implements Serializable

An UserPreference is used to store settings specific to an User. It is always assigned to a particular User and not accessible from, nor valid for, other Users. UserPreferences cannot be overruled by any other type of Preferences.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private String	key	Key value of the UserPreference.
private String	owner	Owner of the UserPreference.

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

description, maximum, minimum, type, value

Constructor Summary

Constructors

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

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 UserPreference.

key

private String key

Key value of the UserPreference.

Constructor Details

UserPreference

public UserPreference()

Create a new UserPreference. Defined for the JAXB implementation.

UserPreference

public UserPreference(String owner,
 String key)

Create a new UserPreference.

Parameters:

owner - The User's username is set as owner of this preference

key - The key of this preference

Throws:

IllegalArgumentException - when owner or key is null or empty

Method Details

getOwner

public String getOwner()

Get the owner.

Returns:

the owner.

setOwner

public void setOwner(String owner)

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

See Also:

• AbstractPreference.getFields()

getPrefKey

public PreferenceKey getPrefKey()

Return a PreferenceKey of this preference.

Specified by:

getPrefKey in class AbstractPreference

Returns:

A PreferenceKey

See Also:

• AbstractPreference.getPrefKey()

hashCode

public int hashCode()

Uses key, owner and type for hashCode calculation.

Overrides:

hashCode in class GenericPreference

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

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

Overrides:

equals in class GenericPreference

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Use all fields.

Overrides:

toString in class GenericPreference