Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.preference

Class MetisPreferenceSet

java.lang.Object

io.github.tonywasher.joceanus.metis.preference.MetisPreferenceSet

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem, OceanusEventRegistrar.OceanusEventProvider<MetisPreferenceEvent>

Direct Known Subclasses:

MetisFieldColours.MetisColorPreferences, MoneyWiseQIFPreference.MoneyWiseQIFPreferences, MoneyWiseUKTaxAnalysis.MoneyWiseUKTaxPreferences, PrometheusBackup.PrometheusBackupPreferences, PrometheusPreferenceSet

public abstract class MetisPreferenceSet
extends Object
implements MetisFieldItem, OceanusEventRegistrar.OceanusEventProvider<MetisPreferenceEvent>

Wrapper class for java preferences.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetisPreferenceSet.MetisBooleanPreference	Boolean preference.
static class	MetisPreferenceSet.MetisDatePreference	Date preference.
static class	MetisPreferenceSet.MetisEnumPreference<E extends Enum<E>>	Enum preference.
static class	MetisPreferenceSet.MetisIntegerPreference	Integer preference.
static interface	MetisPreferenceSet.MetisPreferenceId	Id interface.
static class	MetisPreferenceSet.MetisPreferenceItem	Underlying preference item class.
static class	MetisPreferenceSet.MetisStringPreference	String preference.

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldUpdatableItem, MetisFieldItem.MetisFieldVersionedDef

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ERROR_INVALID	Invalid preference string.
protected static final String	ERROR_UNKNOWN	Unknown preference string.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetisPreferenceSet(MetisPreferenceManager pManager, OceanusBundleId pId)	Constructor.
protected	MetisPreferenceSet(MetisPreferenceManager pManager, String pName)	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	autoCorrectPreferences()	Hook to enable preferenceSets to autoCorrect their preferences.
protected boolean	checkExists(MetisPreferenceKey pKey)	Check whether a preference exists.
(package private) void	declarePreference(MetisPreferenceSet.MetisPreferenceItem pPref)	Declare preference.
protected MetisPreferenceSet.MetisBooleanPreference	defineBooleanPreference(MetisPreferenceKey pKey)	Define new Boolean preference.
protected MetisPreferenceSet.MetisStringPreference	defineColorPreference(MetisPreferenceKey pKey)	Define new Colour preference.
protected MetisPreferenceSet.MetisDatePreference	defineDatePreference(MetisPreferenceKey pKey)	Define new Date preference.
protected MetisPreferenceSet.MetisStringPreference	defineDirectoryPreference(MetisPreferenceKey pKey)	Define new Directory preference.
protected <E extends Enum<E>> MetisPreferenceSet.MetisEnumPreference<E>	defineEnumPreference(MetisPreferenceKey pKey, Class<E> pClazz)	Define new Enum preference.
protected MetisPreferenceSet.MetisStringPreference	defineFilePreference(MetisPreferenceKey pKey)	Define new File preference.
protected MetisPreferenceSet.MetisIntegerPreference	defineIntegerPreference(MetisPreferenceKey pKey)	Define new Integer preference.
protected void	definePreference(MetisPreferenceSet.MetisPreferenceItem pPreference)	Define a preference for the node.
protected abstract void	definePreferences()	Hook to enable preferenceSets to define their preferences.
protected MetisPreferenceSet.MetisStringPreference	defineStringPreference(MetisPreferenceKey pKey)	Define new String preference.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
MetisPreferenceSet.MetisBooleanPreference	getBooleanPreference(MetisPreferenceKey pKey)	Obtain Boolean preference.
Boolean	getBooleanValue(MetisPreferenceKey pKey)	Obtain Boolean value.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
MetisPreferenceSet.MetisDatePreference	getDatePreference(MetisPreferenceKey pKey)	Obtain Date preference.
OceanusDate	getDateValue(MetisPreferenceKey pKey)	Obtain Date value.
<E extends Enum<E>> MetisPreferenceSet.MetisEnumPreference<E>	getEnumPreference(MetisPreferenceKey pKey, Class<E> pClazz)	Obtain Enum preference.
<E extends Enum<E>> E	getEnumValue(MetisPreferenceKey pKey, Class<E> pClazz)	Obtain Enum value.
OceanusEventRegistrar<MetisPreferenceEvent>	getEventRegistrar()	Obtain registration object for listeners.
MetisPreferenceSet.MetisIntegerPreference	getIntegerPreference(MetisPreferenceKey pKey)	Obtain Integer preference.
Integer	getIntegerValue(MetisPreferenceKey pKey)	Obtain Integer value.
String	getName()	Obtain the name of the set.
MetisPreferenceSet.MetisPreferenceItem	getPreference(MetisPreferenceKey pKey)	Obtain preference by key.
protected MetisPreferenceSet.MetisPreferenceItem	getPreference(String pName)	Obtain preference.
MetisPreferenceManager	getPreferenceManager()	Obtain the preference manager.
Collection<MetisPreferenceSet.MetisPreferenceItem>	getPreferences()	Obtain the collection of preferences.
MetisPreferenceSet.MetisStringPreference	getStringPreference(MetisPreferenceKey pKey)	Obtain String preference.
String	getStringValue(MetisPreferenceKey pKey)	Obtain String value.
boolean	hasChanges()	Does the preference set have changes.
boolean	isHidden()	Is this a hidden preferenceSet?
void	resetChanges()	Reset all changes in this preference set.
void	setFocus()	Set the focus.
protected void	setHidden()	Set this preferenceSet as hidden.
final void	storeChanges()	Store preference changes.
void	updateViewerEntry()	Update the viewer entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ERROR_UNKNOWN

protected static final String ERROR_UNKNOWN

Unknown preference string.

See Also:

• Constant Field Values

ERROR_INVALID

protected static final String ERROR_INVALID

Invalid preference string.

See Also:

• Constant Field Values

Constructor Details

MetisPreferenceSet

protected MetisPreferenceSet(MetisPreferenceManager pManager,
 OceanusBundleId pId)
                      throws OceanusException

Constructor.

Parameters:

pManager - the preference manager

pId - the resource id for the set name

Throws:

OceanusException - on error

MetisPreferenceSet

protected MetisPreferenceSet(MetisPreferenceManager pManager,
 String pName)
                      throws OceanusException

Constructor.

Parameters:

pManager - the preference manager

pName - the set name

Throws:

OceanusException - on error

Method Details

getPreferenceManager

public MetisPreferenceManager getPreferenceManager()

Obtain the preference manager.

Returns:

the manager

getDataFieldSet

public MetisFieldItem.MetisFieldSetDef getDataFieldSet()

Description copied from interface: MetisFieldItem

Obtain the fieldSet.

Specified by:

getDataFieldSet in interface MetisFieldItem

Returns:

the fieldSet

formatObject

public String formatObject(OceanusDataFormatter pFormatter)

Description copied from interface: MetisDataItem.MetisDataObjectFormat

Obtain Object summary.

Specified by:

formatObject in interface MetisDataItem.MetisDataObjectFormat

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

declarePreference

void declarePreference(MetisPreferenceSet.MetisPreferenceItem pPref)

Declare preference.

Parameters:

pPref - the preference to declare

getEventRegistrar

public OceanusEventRegistrar<MetisPreferenceEvent> getEventRegistrar()

Description copied from interface: OceanusEventRegistrar.OceanusEventProvider

Obtain registration object for listeners.

Specified by:

getEventRegistrar in interface OceanusEventRegistrar.OceanusEventProvider<MetisPreferenceEvent>

Returns:

the registrar

definePreferences

protected abstract void definePreferences()
                                   throws OceanusException

Hook to enable preferenceSets to define their preferences.

Throws:

OceanusException - on error

autoCorrectPreferences

public abstract void autoCorrectPreferences()

Hook to enable preferenceSets to autoCorrect their preferences.

This is used both to initialise preferencesSet defaults and to adjust the set when a value changes.

getName

public String getName()

Obtain the name of the set.

Returns:

the name

isHidden

public boolean isHidden()

Is this a hidden preferenceSet?

Returns:

true/false

setHidden

protected void setHidden()

Set this preferenceSet as hidden.

getPreferences

public Collection<MetisPreferenceSet.MetisPreferenceItem> getPreferences()

Obtain the collection of preferences.

Returns:

the preferences

setFocus

public void setFocus()

Set the focus.

updateViewerEntry

public void updateViewerEntry()

Update the viewer entry.

defineStringPreference

protected MetisPreferenceSet.MetisStringPreference defineStringPreference(MetisPreferenceKey pKey)

Define new String preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineFilePreference

protected MetisPreferenceSet.MetisStringPreference defineFilePreference(MetisPreferenceKey pKey)

Define new File preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineDirectoryPreference

protected MetisPreferenceSet.MetisStringPreference defineDirectoryPreference(MetisPreferenceKey pKey)

Define new Directory preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineColorPreference

protected MetisPreferenceSet.MetisStringPreference defineColorPreference(MetisPreferenceKey pKey)

Define new Colour preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineIntegerPreference

protected MetisPreferenceSet.MetisIntegerPreference defineIntegerPreference(MetisPreferenceKey pKey)

Define new Integer preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineBooleanPreference

protected MetisPreferenceSet.MetisBooleanPreference defineBooleanPreference(MetisPreferenceKey pKey)

Define new Boolean preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineDatePreference

protected MetisPreferenceSet.MetisDatePreference defineDatePreference(MetisPreferenceKey pKey)

Define new Date preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineEnumPreference

protected <E extends Enum<E>>
MetisPreferenceSet.MetisEnumPreference<E> defineEnumPreference(MetisPreferenceKey pKey,
 Class<E> pClazz)

Define new Enum preference.

Type Parameters:

E - the Enum type

Parameters:

pKey - the key for the preference

pClazz - the Enum class

Returns:

the newly created preference

definePreference

protected void definePreference(MetisPreferenceSet.MetisPreferenceItem pPreference)

Define a preference for the node.

Parameters:

pPreference - the preference to define

getPreference

public MetisPreferenceSet.MetisPreferenceItem getPreference(MetisPreferenceKey pKey)

Obtain preference by key.

Parameters:

pKey - the key of the preference

Returns:

the preference

getPreference

protected MetisPreferenceSet.MetisPreferenceItem getPreference(String pName)

Obtain preference.

Parameters:

pName - the name of the preference

Returns:

the preference

getStringPreference

public MetisPreferenceSet.MetisStringPreference getStringPreference(MetisPreferenceKey pKey)

Obtain String preference.

Parameters:

pKey - the key of the preference

Returns:

the String preference

getStringValue

public String getStringValue(MetisPreferenceKey pKey)

Obtain String value.

Parameters:

pKey - the key of the preference

Returns:

the String value

getIntegerPreference

public MetisPreferenceSet.MetisIntegerPreference getIntegerPreference(MetisPreferenceKey pKey)

Obtain Integer preference.

Parameters:

pKey - the key of the preference

Returns:

the Integer preference

getIntegerValue

public Integer getIntegerValue(MetisPreferenceKey pKey)

Obtain Integer value.

Parameters:

pKey - the key of the preference

Returns:

the Integer value

getBooleanPreference

public MetisPreferenceSet.MetisBooleanPreference getBooleanPreference(MetisPreferenceKey pKey)

Obtain Boolean preference.

Parameters:

pKey - the key of the preference

Returns:

the Boolean preference

getBooleanValue

public Boolean getBooleanValue(MetisPreferenceKey pKey)

Obtain Boolean value.

Parameters:

pKey - the key of the preference

Returns:

the Boolean value

getDatePreference

public MetisPreferenceSet.MetisDatePreference getDatePreference(MetisPreferenceKey pKey)

Obtain Date preference.

Parameters:

pKey - the key of the preference

Returns:

the Date preference

getDateValue

public OceanusDate getDateValue(MetisPreferenceKey pKey)

Obtain Date value.

Parameters:

pKey - the key of the preference

Returns:

the Date value

getEnumPreference

public <E extends Enum<E>>
MetisPreferenceSet.MetisEnumPreference<E> getEnumPreference(MetisPreferenceKey pKey,
 Class<E> pClazz)

Obtain Enum preference.

Type Parameters:

E - the EnumType

Parameters:

pKey - the key of the preference

pClazz - the Enum class

Returns:

the Enum preference

getEnumValue

public <E extends Enum<E>> E getEnumValue(MetisPreferenceKey pKey,
 Class<E> pClazz)

Obtain Enum value.

Type Parameters:

E - the EnumType

Parameters:

pKey - the key of the preference

pClazz - the Enum class

Returns:

the Enum value

resetChanges

public void resetChanges()

Reset all changes in this preference set.

storeChanges

public final void storeChanges()
                        throws OceanusException

Store preference changes.

Throws:

OceanusException - on error

hasChanges

public boolean hasChanges()

Does the preference set have changes.

Returns:

true/false

checkExists

protected boolean checkExists(MetisPreferenceKey pKey)

Check whether a preference exists.

Parameters:

pKey - the key of the preference

Returns:

whether the preference already exists