Module io.github.tonywasher.joceanus.metis

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

Class MetisPreferenceManager

java.lang.Object

io.github.tonywasher.joceanus.metis.preference.MetisPreferenceManager

All Implemented Interfaces:

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

Direct Known Subclasses:

PrometheusPreferenceManager

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

Manager class for preference sets.

Author:

Tony Washer

Nested Class Summary

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

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetCtl<T extends MetisFieldItem>, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldVersionedDef

Constructor Summary

Constructors

Constructor	Description
MetisPreferenceManager(MetisViewerManager pViewer)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
MetisFieldSet<MetisPreferenceManager>	getDataFieldSet()	Obtain the fieldSet.
OceanusEventRegistrar<MetisPreferenceEvent>	getEventRegistrar()	Obtain registration object for listeners.
protected MetisPreferenceParams	getParameters()	Obtain the parameters.
<X extends MetisPreferenceSet> X	getPreferenceSet(Class<X> pClazz)	Obtain the preference set for the calling class.
Collection<MetisPreferenceSet>	getPreferenceSets()	Obtain the collection of preference sets.
protected <X extends MetisPreferenceSet> X	newPreferenceSet(String pName, Class<X> pClazz)	Create a new preferenceSet.
protected void	setParameters(MetisPreferenceParams pParams)	Set the parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

MetisPreferenceManager

public MetisPreferenceManager(MetisViewerManager pViewer)
                       throws OceanusException

Constructor.

Parameters:

pViewer - the viewer manager

Throws:

OceanusException - on error

Method Details

getDataFieldSet

public MetisFieldSet<MetisPreferenceManager> 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

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

getParameters

protected MetisPreferenceParams getParameters()

Obtain the parameters.

Returns:

the parameters

setParameters

protected void setParameters(MetisPreferenceParams pParams)

Set the parameters.

Parameters:

pParams - the parameters

getPreferenceSets

public Collection<MetisPreferenceSet> getPreferenceSets()

Obtain the collection of preference sets.

Returns:

the preference sets

getPreferenceSet

public <X extends MetisPreferenceSet> X getPreferenceSet(Class<X> pClazz)

Obtain the preference set for the calling class.

Type Parameters:

X - the preference set type

Parameters:

pClazz - the class of the preference set

Returns:

the relevant preferenceSet

newPreferenceSet

protected <X extends MetisPreferenceSet> X newPreferenceSet(String pName,
 Class<X> pClazz)

Create a new preferenceSet.

Type Parameters:

X - the preference set type

Parameters:

pName - the name of the preference set

pClazz - the class of the preference set

Returns:

the new preferenceSet