org.rvpf.base.util.container

Class KeyedGroups

Object

KeyedValues

KeyedGroups

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConfigProperties, SOMFactory.Properties, SOMProxy.ContextProperties, Traces.Context

@NotThreadSafe
public class KeyedGroups
extends KeyedValues

Dictionary of KeyedValues.

Extends KeyedValues to allow a hierarchy of KeyedValues.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static KeyedGroups	MISSING_KEYED_GROUP Missing keyed groups.
static KeyedGroups[]	NO_KEYED_GROUPS No keyed groups.

Fields inherited from class KeyedValues

ANONYMOUS, HASH_LOAD_FACTOR, MAP_ENTRY_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
	KeyedGroups() Constructs an instance.
protected	KeyedGroups(KeyedGroups other) Constructs an instance from an other.
protected	KeyedGroups(String type, Optional<String> name) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	addAll(KeyedGroups keyedGroups) Adds all entries from an other KeyedGroups.
void	addGroup(String key, KeyedGroups properties) Adds a group of keyed groups.
void	clear() Clears the dictionary.
boolean	containsGroupKey(String key) Asks if the key is associated with a group.
KeyedGroups	copy() Creates a copy of this.
boolean	equals(Object other)
KeyedGroups	freeze() Freezes this.
KeyedGroups	frozen() Returns a frozen copy of this.
KeyedGroups	getGroup(String key) Gets a group of keyed values.
KeyedGroups[]	getGroups(String key) Gets the groups for the specified key.
Set<Map.Entry<String,List<Object>>>	getGroupsEntries() Gets the set of group entries for readonly access.
Set<String>	getGroupsKeys() Gets the set of keys for the groups.
int	getGroupsSize() Gets the size of the groups map.
protected KeyedGroups	getMissingGroup() Gets the missing group.
Optional<String>	getName() Gets the name.
protected KeyedGroups[]	getNoGroups() Gets no groups.
int	hashCode()
boolean	isEmpty() Asks if this is empty.
boolean	isMissing() Asks if this is the missing group.
void	removeGroup(String key) Removes a group.
void	setGroup(String key, KeyedGroups properties) Sets a group.
void	setValue(String key, Object value) Sets a keyed value.
KeyedGroups	thawed() Returns a thawed instance of this.
Map<String,String>	toPropertiesMap() Returns the first value for each key in a properties map.

Methods inherited from class KeyedValues

add, addAll, addObject, areValuesHidden, checkNotFrozen, containsValueKey, getBoolean, getBoolean, getBoolean, getClassDef, getClassDef, getClassDefs, getDouble, getElapsed, getInt, getInteger, getLong, getLong, getObject, getObjects, 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_KEYED_GROUP

public static final KeyedGroups MISSING_KEYED_GROUP

Missing keyed groups.

NO_KEYED_GROUPS

public static final KeyedGroups[] NO_KEYED_GROUPS

No keyed groups.

Constructor Detail

KeyedGroups

public KeyedGroups()

Constructs an instance.

KeyedGroups

protected KeyedGroups(@Nonnull
                      KeyedGroups other)

Constructs an instance from an other.

Parameters:

other - The other instance.

KeyedGroups

protected KeyedGroups(@Nonnull
                      String type,
                      @Nonnull
                      Optional<String> name)

Constructs an instance.

Parameters:

type - A string identifying the type of value stored.

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

Method Detail

addAll

public final void addAll(@Nonnull
                         KeyedGroups keyedGroups)

Adds all entries from an other KeyedGroups.

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

Parameters:

keyedGroups - The other keyed groups.

addGroup

public void addGroup(@Nonnull
                     String key,
                     @Nonnull
                     KeyedGroups properties)

Adds a group of keyed groups.

If the key is already in the dictionary, the group is appended to the list of groups for that key.

If the key is null, the effect is the same as addAll(org.rvpf.base.util.container.KeyedGroups).

Parameters:

key - The name of the group.

properties - The keyed groups.

clear

public final void clear()

Clears the dictionary.

Overrides:

clear in class KeyedValues

containsGroupKey

@CheckReturnValue
public boolean containsGroupKey(@Nonnull
                                                   String key)

Asks if the key is associated with a group.

Parameters:

key - The key to look for.

Returns:

True if the key is associated with a group.

copy

public KeyedGroups copy()

Creates a copy of this.

Overrides:

copy in class KeyedValues

Returns:

The copy.

equals

public boolean equals(Object other)

Overrides:

equals in class KeyedValues

freeze

public KeyedGroups freeze()

Freezes this.

Overrides:

freeze in class KeyedValues

Returns:

This.

frozen

public KeyedGroups frozen()

Returns a frozen copy of this.

Overrides:

frozen in class KeyedValues

Returns:

This if already frozen, or a frozen copy.

getGroup

@Nonnull
 @CheckReturnValue
public KeyedGroups getGroup(@Nonnull
                                                          String key)

Gets a group of keyed values.

Parameters:

key - The name of the group.

Returns:

The Properties (may be the missing group).

getGroups

@Nonnull
 @CheckReturnValue
public KeyedGroups[] getGroups(@Nonnull
                                                             String key)

Gets the groups for the specified key.

Parameters:

key - The groups name.

Returns:

An array of groups (may be empty).

getGroupsEntries

@Nonnull
 @CheckReturnValue
public final Set<Map.Entry<String,List<Object>>> getGroupsEntries()

Gets the set of group entries for readonly access.

Returns:

The set of group entries.

getGroupsKeys

@Nonnull
 @CheckReturnValue
public final Set<String> getGroupsKeys()

Gets the set of keys for the groups.

Returns:

The set of keys for the groups.

getGroupsSize

@CheckReturnValue
public int getGroupsSize()

Gets the size of the groups map.

Returns:

The size of the groups map.

getName

public final Optional<String> getName()

Gets the name.

Returns:

The optional name.

hashCode

public int hashCode()

Overrides:

hashCode in class KeyedValues

isEmpty

public boolean isEmpty()

Asks if this is empty.

Overrides:

isEmpty in class KeyedValues

Returns:

True if this is empty.

isMissing

@CheckReturnValue
public boolean isMissing()

Asks if this is the missing group.

Returns:

True if this is the missing group.

removeGroup

public final void removeGroup(@Nonnull
                              String key)

Removes a group.

Parameters:

key - The name of the group.

setGroup

public final void setGroup(@Nonnull
                           String key,
                           @Nonnull
                           KeyedGroups properties)

Sets a group.

Parameters:

key - The name of the group.

properties - The group.

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 KeyedValues

Parameters:

key - The value key.

value - The value.

thawed

public KeyedGroups thawed()

Returns a thawed instance of this.

Overrides:

thawed in class KeyedValues

Returns:

A clone if frozen, or this.

toPropertiesMap

@Nonnull
 @CheckReturnValue
public final Map<String,String> toPropertiesMap()

Returns the first value for each key in a properties map.

Returns:

The properties map.

getMissingGroup

@Nonnull
 @CheckReturnValue
protected KeyedGroups getMissingGroup()

Gets the missing group.

Returns:

A frozen and empty keyed groups.

getNoGroups

@Nonnull
 @CheckReturnValue
protected KeyedGroups[] getNoGroups()

Gets no groups.

Returns:

An empty keyed groups array.