org.rvpf.config

Class ConfigProperties

Object

KeyedValues

KeyedGroups

ConfigProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ServiceContext

@NotThreadSafe
public class ConfigProperties
extends KeyedGroups

Dictionary of values.

This class extends KeyedGroups by providing property change listener and dictionary hierarchy support.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigProperties	MISSING_CONFIG_PROPERTIES Missing configuration properties.
static ConfigProperties[]	NO_CONFIG_PROPERTIES No configuration properties.

Fields inherited from class KeyedGroups

MISSING_KEYED_GROUP, NO_KEYED_GROUPS

Fields inherited from class KeyedValues

ANONYMOUS, HASH_LOAD_FACTOR, MAP_ENTRY_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
ConfigProperties() Constructs an instance.
ConfigProperties(Messages.Entry type) Constructs an instance.
ConfigProperties(Messages.Entry type, Optional<String> name) Constructs an instance.
ConfigProperties(Optional<String> name) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	add(KeyedGroups otherInstance) Adds all the properties from an other instance.
void	add(Properties properties) Adds properties.
void	add(String key, Object value) Adds a keyed value.
void	addPropertyChangeListener(String key, PropertyChangeListener listener) Adds a property change listener.
void	clearOverriden() Clears the overriden properties.
boolean	containsGroupKey(String key) Asks if the key is associated with a group.
boolean	containsValueKey(String key) Asks if the key is associated with a value.
ConfigProperties	copy() Creates a copy of this.
boolean	equals(Object other)
ConfigProperties	freeze() Freezes this.
ConfigProperties	getGroup(String key) Gets a group of keyed values.
KeyedGroups[]	getGroups(String key) Gets the groups for the specified key.
protected ConfigProperties	getMissingGroup() Gets the missing group.
protected ConfigProperties[]	getNoGroups() Gets no groups.
List<Object>	getObjects(String key) Gets the object list for a key.
Optional<ConfigProperties>	getOverriden() Gets the overriden properties.
Optional<ConfigProperties>	getOverrider() Gets the overrider properties.
int	hashCode()
boolean	isEmpty() Asks if this is empty.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property change Listener.
void	restoreMonitoredValues(Object values) Restores monitored values.
Object	saveMonitoredValues() Saves monitored values.
void	setOverriden(ConfigProperties overriden) Sets the overriden properties.
void	setOverrider(ConfigProperties overrider) Sets the overrider properties.
void	setValue(String key, Object value) Sets a keyed value.

Methods inherited from class KeyedGroups

addAll, addGroup, clear, frozen, getGroupsEntries, getGroupsKeys, getGroupsSize, getName, isMissing, removeGroup, setGroup, thawed, toPropertiesMap

Methods inherited from class KeyedValues

addAll, addObject, areValuesHidden, checkNotFrozen, getBoolean, getBoolean, getBoolean, getClassDef, getClassDef, getClassDefs, getDouble, getElapsed, getInt, getInteger, getLong, getLong, getObject, getPassword, getString, getString, getStrings, getThisLogger, getType, getValues, getValuesEntries, getValuesKeys, getValuesSize, hashCapacity, isFrozen, isHidden, isMultiple, removeValue, setHidden, setObjects, setValuesHidden, substitute, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MISSING_CONFIG_PROPERTIES

public static final ConfigProperties MISSING_CONFIG_PROPERTIES

Missing configuration properties.

NO_CONFIG_PROPERTIES

public static final ConfigProperties[] NO_CONFIG_PROPERTIES

No configuration properties.

Constructor Detail

ConfigProperties

public ConfigProperties()

Constructs an instance.

ConfigProperties

public ConfigProperties(@Nonnull
                        Messages.Entry type)

Constructs an instance.

Parameters:

type - The type of values (for logging purpose).

ConfigProperties

public ConfigProperties(@Nonnull
                        Optional<String> name)

Constructs an instance.

Parameters:

name - The optional name for the properties as a group.

ConfigProperties

public ConfigProperties(@Nonnull
                        Messages.Entry type,
                        @Nonnull
                        Optional<String> name)

Constructs an instance.

Parameters:

type - The type of values (for logging purpose).

name - The optional name for the properties as a group.

Method Detail

add

public void add(@Nonnull
                KeyedGroups otherInstance)

Adds all the properties from an other instance.

The new values and groups are appended to those already present.

Parameters:

otherInstance - The other instance.

add

public void add(@Nonnull
                Properties properties)

Adds properties.

The new properties are appended to those already present.

Parameters:

properties - The new properties.

add

public void add(String key,
                Object value)

Adds a keyed value.

If the key is already in the dictionary, the value is appended to the list of values for that key.

Overrides:

add in class KeyedValues

Parameters:

key - The value key.

value - The value.

addPropertyChangeListener

public final void addPropertyChangeListener(@Nonnull
                                            String key,
                                            @Nonnull
                                            PropertyChangeListener listener)

Adds a property change listener.

Parameters:

key - The key of the property to be monitored.

listener - The listener.

clearOverriden

public void clearOverriden()

Clears the overriden properties.

containsGroupKey

public final boolean containsGroupKey(String key)

Asks if the key is associated with a group.

Overrides:

containsGroupKey in class KeyedGroups

Parameters:

key - The key to look for.

Returns:

True if the key is associated with a group.

containsValueKey

public final boolean containsValueKey(String key)

Asks if the key is associated with a value.

Overrides:

containsValueKey in class KeyedValues

Parameters:

key - The key to look for.

Returns:

True if the key is associated with a value.

copy

public ConfigProperties copy()

Creates a copy of this.

Overrides:

copy in class KeyedGroups

Returns:

The copy.

equals

public final boolean equals(Object other)

Overrides:

equals in class KeyedGroups

freeze

@Nonnull
public ConfigProperties freeze()

Freezes this.

Overrides:

freeze in class KeyedGroups

Returns:

This.

getGroup

public final ConfigProperties getGroup(String key)

Gets a group of keyed values.

Overrides:

getGroup in class KeyedGroups

Parameters:

key - The name of the group.

Returns:

The Properties (may be the missing group).

getGroups

public final KeyedGroups[] getGroups(String key)

Gets the groups for the specified key.

Overrides:

getGroups in class KeyedGroups

Parameters:

key - The groups name.

Returns:

An array of groups (may be empty).

getObjects

public final List<Object> getObjects(String key)

Gets the object list for a key.

Overrides:

getObjects in class KeyedValues

Parameters:

key - The object key.

Returns:

The object list (null if none).

getOverriden

@Nonnull
 @CheckReturnValue
public final Optional<ConfigProperties> getOverriden()

Gets the overriden properties.

Returns:

The optional overriden properties.

getOverrider

@Nonnull
 @CheckReturnValue
public final Optional<ConfigProperties> getOverrider()

Gets the overrider properties.

Returns:

The optional overrider properties.

hashCode

public final int hashCode()

Overrides:

hashCode in class KeyedGroups

isEmpty

public boolean isEmpty()

Asks if this is empty.

Overrides:

isEmpty in class KeyedGroups

Returns:

True if this is empty.

removePropertyChangeListener

public final void removePropertyChangeListener(@Nonnull
                                               PropertyChangeListener listener)

Removes a property change Listener.

Parameters:

listener - The Listener.

restoreMonitoredValues

public final void restoreMonitoredValues(@Nonnull
                                         Object values)

Restores monitored values.

This is used by DocumentLoader to restore dynamic properties at the end of an 'include' PI.

Parameters:

values - The opaque object containing the monitored values.

saveMonitoredValues

@Nonnull
 @CheckReturnValue
public final Object saveMonitoredValues()

Saves monitored values.

This is used by DocumentLoader to save dynamic properties at the beginning of an 'include' PI.

Returns:

An opaque object containing the monitored values.

setOverriden

public void setOverriden(@Nonnull
                         ConfigProperties overriden)

Sets the overriden properties.

Parameters:

overriden - The overriden properties.

setOverrider

public void setOverrider(@Nonnull
                         ConfigProperties overrider)

Sets the overrider properties.

Parameters:

overrider - The overrider properties.

setValue

public void setValue(String key,
                     Object value)

Sets a keyed value.

If the key is already in the dictionary, its value is replaced.

Overrides:

setValue in class KeyedGroups

Parameters:

key - The value key.

value - The value.

getMissingGroup

protected final ConfigProperties getMissingGroup()

Gets the missing group.

Overrides:

getMissingGroup in class KeyedGroups

Returns:

A frozen and empty keyed groups.

getNoGroups

protected final ConfigProperties[] getNoGroups()

Gets no groups.

Overrides:

getNoGroups in class KeyedGroups

Returns:

An empty keyed groups array.