Module io.github.tonywasher.joceanus.prometheus.core

Package io.github.tonywasher.joceanus.prometheus.preference

Class PrometheusPreferenceSet

java.lang.Object

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

io.github.tonywasher.joceanus.prometheus.preference.PrometheusPreferenceSet

All Implemented Interfaces:

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

Direct Known Subclasses:

PrometheusDatabase.PrometheusDatabasePreferences, PrometheusPreferenceSecurity.PrometheusBaseSecurityPreferences, PrometheusPreferenceSecurity.PrometheusSecurityPreferences

public abstract class PrometheusPreferenceSet
extends MetisPreferenceSet

Prometheus PreferenceSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusPreferenceSet.PrometheusByteArrayPreference	ByteArray preference.
static class	PrometheusPreferenceSet.PrometheusCharArrayPreference	CharArray preference.

Nested classes/interfaces inherited from class io.github.tonywasher.joceanus.metis.preference.MetisPreferenceSet

MetisPreferenceSet.MetisBooleanPreference, MetisPreferenceSet.MetisDatePreference, MetisPreferenceSet.MetisEnumPreference<E extends Enum<E>>, MetisPreferenceSet.MetisIntegerPreference, MetisPreferenceSet.MetisPreferenceId, MetisPreferenceSet.MetisPreferenceItem, MetisPreferenceSet.MetisStringPreference

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 inherited from class io.github.tonywasher.joceanus.metis.preference.MetisPreferenceSet

ERROR_INVALID, ERROR_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusPreferenceSet(PrometheusPreferenceManager pManager, OceanusBundleId pId)	Constructor.
protected	PrometheusPreferenceSet(PrometheusPreferenceManager pManager, String pName)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected PrometheusPreferenceSet.PrometheusByteArrayPreference	defineByteArrayPreference(MetisPreferenceKey pKey)	Define new ByteArray preference.
protected PrometheusPreferenceSet.PrometheusCharArrayPreference	defineCharArrayPreference(MetisPreferenceKey pKey)	Define new CharArray preference.
PrometheusPreferenceSet.PrometheusByteArrayPreference	getByteArrayPreference(MetisPreferenceKey pKey)	Obtain ByteArray preference.
byte[]	getByteArrayValue(MetisPreferenceKey pKey)	Obtain ByteArray value.
PrometheusPreferenceSet.PrometheusCharArrayPreference	getCharArrayPreference(MetisPreferenceKey pKey)	Obtain CharArray preference.
char[]	getCharArrayValue(MetisPreferenceKey pKey)	Obtain CharArray value.
PrometheusPreferenceManager	getPreferenceManager()	Obtain the preference manager.
PrometheusPreferenceSecurity	getSecurity()	Obtain the security.

Methods inherited from class io.github.tonywasher.joceanus.metis.preference.MetisPreferenceSet

autoCorrectPreferences, checkExists, defineBooleanPreference, defineColorPreference, defineDatePreference, defineDirectoryPreference, defineEnumPreference, defineFilePreference, defineIntegerPreference, definePreference, definePreferences, defineStringPreference, formatObject, getBooleanPreference, getBooleanValue, getDataFieldSet, getDatePreference, getDateValue, getEnumPreference, getEnumValue, getEventRegistrar, getIntegerPreference, getIntegerValue, getName, getPreference, getPreference, getPreferences, getStringPreference, getStringValue, hasChanges, isHidden, resetChanges, setFocus, setHidden, storeChanges, updateViewerEntry

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusPreferenceSet

protected PrometheusPreferenceSet(PrometheusPreferenceManager pManager,
 OceanusBundleId pId)
                           throws OceanusException

Constructor.

Parameters:

pManager - the preference manager

pId - the Id

Throws:

OceanusException - on error

PrometheusPreferenceSet

protected PrometheusPreferenceSet(PrometheusPreferenceManager pManager,
 String pName)
                           throws OceanusException

Constructor.

Parameters:

pManager - the preference manager

pName - the name

Throws:

OceanusException - on error

Method Details

getPreferenceManager

public PrometheusPreferenceManager getPreferenceManager()

Description copied from class: MetisPreferenceSet

Obtain the preference manager.

Overrides:

getPreferenceManager in class MetisPreferenceSet

Returns:

the manager

getSecurity

public PrometheusPreferenceSecurity getSecurity()
                                         throws OceanusException

Obtain the security.

Returns:

the security

Throws:

OceanusException - on error

defineByteArrayPreference

protected PrometheusPreferenceSet.PrometheusByteArrayPreference defineByteArrayPreference(MetisPreferenceKey pKey)

Define new ByteArray preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

defineCharArrayPreference

protected PrometheusPreferenceSet.PrometheusCharArrayPreference defineCharArrayPreference(MetisPreferenceKey pKey)
                                                                                   throws OceanusException

Define new CharArray preference.

Parameters:

pKey - the key for the preference

Returns:

the preference item

Throws:

OceanusException - on error

getByteArrayPreference

public PrometheusPreferenceSet.PrometheusByteArrayPreference getByteArrayPreference(MetisPreferenceKey pKey)

Obtain ByteArray preference.

Parameters:

pKey - the key of the preference

Returns:

the ByteArray preference

getByteArrayValue

public byte[] getByteArrayValue(MetisPreferenceKey pKey)

Obtain ByteArray value.

Parameters:

pKey - the key of the preference

Returns:

the ByteArray value

getCharArrayPreference

public PrometheusPreferenceSet.PrometheusCharArrayPreference getCharArrayPreference(MetisPreferenceKey pKey)

Obtain CharArray preference.

Parameters:

pKey - the key of the preference

Returns:

the CharArray preference

getCharArrayValue

public char[] getCharArrayValue(MetisPreferenceKey pKey)

Obtain CharArray value.

Parameters:

pKey - the key of the preference

Returns:

the CharArray value