org.rvpf.base.util.container

Class KeyedValues

Object

KeyedValues

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Attributes, KeyedGroups, Params

@NotThreadSafe
public class KeyedValues
extends Object
implements Serializable

Keyed values.

Keyed values may hold any number of entries. Each entry is a key associated with one value or more. The order of entries within the dictionary and of values within entry are in the order of their initial insertion.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS Anonymous entry.
static float	HASH_LOAD_FACTOR Hash load factor.
protected static Comparator<Map.Entry<String,List<Object>>>	MAP_ENTRY_COMPARATOR Map entry comparator.

Constructor Summary

Constructors

Modifier	Constructor and Description
	KeyedValues() Constructs an instance.
protected	KeyedValues(KeyedValues other) Constructs an instance from an other.
	KeyedValues(String type) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	add(String key, Object value) Adds a keyed value.
void	addAll(KeyedValues keyedValues) Adds all entries from an other keyed values.
protected void	addObject(String key, Object object) Adds a keyed object.
boolean	areValuesHidden(String key) Asks if the values for a key are hidden.
protected void	checkNotFrozen() Checks that this is not frozen.
void	clear() Clears the dictionary.
boolean	containsValueKey(String key) Asks if the key is associated with a value.
KeyedValues	copy() Creates a copy of this.
boolean	equals(Object other)
KeyedValues	freeze() Freezes this.
KeyedValues	frozen() Returns a frozen copy of this.
boolean	getBoolean(String key) Gets a boolean value for a key, defaulting to false.
boolean	getBoolean(String key, boolean defaultValue) Gets a boolean value for a key, providing a default.
Optional<Boolean>	getBoolean(String key, Optional<Boolean> defaultValue) Gets a boolean value for a key, providing a default.
ClassDef	getClassDef(String key, ClassDef defaultClassDef) Gets a class definition for a key, providing a default.
Optional<ClassDef>	getClassDef(String key, Optional<ClassDef> defaultClassDef) Gets a class definition for a key, providing a default.
ClassDef[]	getClassDefs(String key) Gets the class definition array for the specified key.
double	getDouble(String key, double defaultValue) Gets a double value for a key, providing a default.
Optional<ElapsedTime>	getElapsed(String key, Optional<ElapsedTime> defaultValue, Optional<ElapsedTime> emptyValue) Gets an elapsed time value for a key, providing a value for default and empty.
int	getInt(String key, int defaultValue) Gets an int value for a key, providing a default.
Optional<Integer>	getInteger(String key, Optional<Integer> defaultValue) Gets an integer value for a key, providing a default.
long	getLong(String key, long defaultValue) Gets a long value for a key, providing a default.
Optional<Long>	getLong(String key, Optional<Long> defaultValue) Gets a long value for a key, providing a default.
Optional<?>	getObject(String key) Gets the object for a key.
List<Object>	getObjects(String key) Gets the object list for a key.
Optional<char[]>	getPassword(String key) Gets the password value for a key.
Optional<String>	getString(String key) Gets a string value for a key.
Optional<String>	getString(String key, Optional<String> defaultValue) Gets the first value for a key, providing a default.
String[]	getStrings(String key) Gets the values for the specified key.
protected Logger	getThisLogger() Gets the logger.
String	getType() Gets the type of value stored in the dictionary.
Object[]	getValues(String key) Gets the values for the specified key.
Set<Map.Entry<String,List<Object>>>	getValuesEntries() Gets the Set of entries.
Set<String>	getValuesKeys() Gets the set of keys for the values.
int	getValuesSize() Gets the size of the values map.
static int	hashCapacity(int count) Computes the hash capacity needed to hold a specified key count.
int	hashCode()
boolean	isEmpty() Asks if this is empty.
boolean	isFrozen() Asks if this is frozen.
boolean	isHidden() Gets the hidden indicator.
boolean	isMultiple(String key) Asks if a key has multiple values.
void	removeValue(String key) Removes a keyed value.
void	setHidden(boolean hidden) Sets the hidden indicator.
protected void	setObjects(String key, List<Object> objects) Sets the object list for a key.
void	setValue(String key, Object value) Sets a keyed value.
void	setValuesHidden(String key) Sets the values hidden for the specified key.
String	substitute(String text, boolean deferred) Substitutes markers in a given text.
KeyedValues	thawed() Returns a thawed instance of this.
String	toString()

Methods inherited from class Object

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

Field Detail

ANONYMOUS

public static final String ANONYMOUS

Anonymous entry.

See Also:

Constant Field Values

HASH_LOAD_FACTOR

public static final float HASH_LOAD_FACTOR

Hash load factor.

See Also:

Constant Field Values

MAP_ENTRY_COMPARATOR

protected static final Comparator<Map.Entry<String,List<Object>>> MAP_ENTRY_COMPARATOR

Map entry comparator.

Constructor Detail

KeyedValues

public KeyedValues()

Constructs an instance.

KeyedValues

public KeyedValues(@Nonnull
                   String type)

Constructs an instance.

Parameters:

type - A string identifying the type of value stored.

KeyedValues

protected KeyedValues(@Nonnull
                      KeyedValues other)

Constructs an instance from an other.

Parameters:

other - The other instance.

Method Detail

hashCapacity

@CheckReturnValue
public static int hashCapacity(int count)

Computes the hash capacity needed to hold a specified key count.

Parameters:

count - The expected key count.

Returns:

The hash capacity.

add

public void add(@Nonnull
                String key,
                @Nonnull
                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.

Parameters:

key - The value key.

value - The value.

addAll

public final void addAll(@Nonnull
                         KeyedValues keyedValues)

Adds all entries from an other keyed values.

The new values are appended to those already present.

Parameters:

keyedValues - The other keyed values.

areValuesHidden

@CheckReturnValue
public boolean areValuesHidden(@Nonnull
                                                  String key)

Asks if the values for a key are hidden.

Parameters:

key - The key.

Returns:

True if the values for the key are hidden.

clear

public void clear()

Clears the dictionary.

containsValueKey

@CheckReturnValue
public boolean containsValueKey(@Nonnull
                                                   String key)

Asks if the key is associated with a value.

Parameters:

key - The key to look for.

Returns:

True if the key is associated with a value.

copy

@Nonnull
 @CheckReturnValue
public KeyedValues copy()

Creates a copy of this.

Returns:

The copy.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

freeze

@Nonnull
public KeyedValues freeze()

Freezes this.

Returns:

This.

frozen

@Nonnull
 @CheckReturnValue
public KeyedValues frozen()

Returns a frozen copy of this.

Returns:

This if already frozen, or a frozen copy.

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nonnull
                                                   String key)

Gets a boolean value for a key, defaulting to false.

If the key is not found or its value is unrecognized, false will be returned.

Parameters:

key - The name of the value.

Returns:

The requested value or false.

See Also:

getBoolean(String key, boolean defaultValue)

getBoolean

@CheckReturnValue
public final boolean getBoolean(@Nonnull
                                                   String key,
                                                   boolean defaultValue)

Gets a boolean value for a key, providing a default.

If the key is not found or its value is unrecognized the default will be returned.

Parameters:

key - The name of the value.

defaultValue - The default value for the key.

Returns:

The requested value or the provided default.

getBoolean

@Nonnull
 @CheckReturnValue
public final Optional<Boolean> getBoolean(@Nonnull
                                                                        String key,
                                                                        @Nonnull
                                                                        Optional<Boolean> defaultValue)

Gets a boolean value for a key, providing a default.

If the key is not found or its value is unrecognized the default will be returned.

Parameters:

key - The name of the value.

defaultValue - The default value for the key (may be empty).

Returns:

The requested value or the provided default (may be empty).

getClassDef

@Nonnull
 @CheckReturnValue
public final ClassDef getClassDef(@Nonnull
                                                                String key,
                                                                @Nonnull
                                                                ClassDef defaultClassDef)

Gets a class definition for a key, providing a default.

A string value will be converted to a class definition.

Parameters:

key - The key for the class definition.

defaultClassDef - The default for the key.

Returns:

The requested class definition or the provided default.

getClassDef

@Nonnull
 @CheckReturnValue
public final Optional<ClassDef> getClassDef(@Nonnull
                                                                          String key,
                                                                          @Nonnull
                                                                          Optional<ClassDef> defaultClassDef)

Gets a class definition for a key, providing a default.

A string value will be converted to a class definition.

Parameters:

key - The key for the class definition.

defaultClassDef - The default for the key.

Returns:

The requested class definition or the provided default.

getClassDefs

@Nonnull
 @CheckReturnValue
public final ClassDef[] getClassDefs(@Nonnull
                                                                   String key)

Gets the class definition array for the specified key.

String values will be converted to class definitionss.

Parameters:

key - The key for the requested class definitions array.

Returns:

The class definition array (may be empty).

getDouble

public final double getDouble(@Nonnull
                              String key,
                              double defaultValue)

Gets a double value for a key, providing a default.

If the key is not found or its value is unrecognized the default will be returned.

Parameters:

key - The key for the value.

defaultValue - The default value.

Returns:

The requested value or the provided default.

getElapsed

@Nonnull
 @CheckReturnValue
public final Optional<ElapsedTime> getElapsed(@Nonnull
                                                                            String key,
                                                                            @Nonnull
                                                                            Optional<ElapsedTime> defaultValue,
                                                                            @Nonnull
                                                                            Optional<ElapsedTime> emptyValue)

Gets an elapsed time value for a key, providing a value for default and empty.

Parameters:

key - The key for the elapsed time.

defaultValue - The default.

emptyValue - The assumed value for empty.

Returns:

The requested elapsed time, empty, or the provided default.

getInt

@CheckReturnValue
public final int getInt(@Nonnull
                                           String key,
                                           int defaultValue)

Gets an int value for a key, providing a default.

If the key is not found or its value is unrecognized, the default will be returned.

Parameters:

key - The name of the value.

defaultValue - The default value.

Returns:

The requested value or the provided default.

getInteger

@Nonnull
 @CheckReturnValue
public final Optional<Integer> getInteger(@Nonnull
                                                                        String key,
                                                                        @Nonnull
                                                                        Optional<Integer> defaultValue)

Gets an integer value for a key, providing a default.

Parameters:

key - The name of the value.

defaultValue - The default value (may be empty).

Returns:

The requested value or the provided default.

getLong

@CheckReturnValue
public final long getLong(@Nonnull
                                             String key,
                                             long defaultValue)

Gets a long value for a key, providing a default.

If the key is not found or its value is unrecognized, the default will be returned.

Parameters:

key - The name of the value.

defaultValue - The default value.

Returns:

The requested value or the provided default.

getLong

@Nonnull
 @CheckReturnValue
public final Optional<Long> getLong(@Nonnull
                                                                  String key,
                                                                  @Nonnull
                                                                  Optional<Long> defaultValue)

Gets a long value for a key, providing a default.

Parameters:

key - The name of the value.

defaultValue - The default value (may be empty).

Returns:

The requested value or the provided default.

getObject

@Nonnull
 @CheckReturnValue
public final Optional<?> getObject(@Nonnull
                                                                 String key)

Gets the object for a key.

Parameters:

key - The object key.

Returns:

The first object or empty.

getObjects

@Nonnull
 @CheckReturnValue
public List<Object> getObjects(@Nonnull
                                                             String key)

Gets the object list for a key.

Parameters:

key - The object key.

Returns:

The object list (null if none).

getPassword

@Nonnull
 @CheckReturnValue
public final Optional<char[]> getPassword(@Nonnull
                                                                        String key)

Gets the password value for a key.

Parameters:

key - The value name.

Returns:

The password value (empty if none).

getString

@Nonnull
 @CheckReturnValue
public final Optional<String> getString(@Nonnull
                                                                      String key)

Gets a string value for a key.

Parameters:

key - The value name.

Returns:

The string value (empty if none).

getString

@Nonnull
 @CheckReturnValue
public final Optional<String> getString(@Nonnull
                                                                      String key,
                                                                      @Nonnull
                                                                      Optional<String> defaultValue)

Gets the first value for a key, providing a default.

Parameters:

key - The value name.

defaultValue - The value to return if the key is not present.

Returns:

The first value (or the provided default if none).

getStrings

@Nonnull
 @CheckReturnValue
public final String[] getStrings(@Nonnull
                                                               String key)

Gets the values for the specified key.

Parameters:

key - The values name.

Returns:

The String array of values (may be empty).

getType

@Nonnull
 @CheckReturnValue
public String getType()

Gets the type of value stored in the dictionary.

Returns:

The type.

getValues

@Nonnull
 @CheckReturnValue
public Object[] getValues(@Nonnull
                                                        String key)

Gets the values for the specified key.

Parameters:

key - The key for the requested values.

Returns:

The array of values (may be empty).

getValuesEntries

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

Gets the Set of entries.

Returns:

The Set of entries.

getValuesKeys

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

Gets the set of keys for the values.

Returns:

The set of keys for the values.

getValuesSize

@CheckReturnValue
public int getValuesSize()

Gets the size of the values map.

Returns:

The size of the values map.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

@CheckReturnValue
public boolean isEmpty()

Asks if this is empty.

Returns:

True if this is empty.

isFrozen

@CheckReturnValue
public final boolean isFrozen()

Asks if this is frozen.

Returns:

True if this is frozen.

isHidden

@CheckReturnValue
public final boolean isHidden()

Gets the hidden indicator.

Returns:

The hidden indicator.

isMultiple

@CheckReturnValue
public boolean isMultiple(@Nonnull
                                             String key)

Asks if a key has multiple values.

Parameters:

key - The key.

Returns:

True if the key has multiple values.

removeValue

public void removeValue(@Nonnull
                        String key)

Removes a keyed value.

Parameters:

key - The value key.

setHidden

public final void setHidden(boolean hidden)

Sets the hidden indicator.

Parameters:

hidden - The hidden indicator.

setValue

public void setValue(@Nonnull
                     String key,
                     @Nonnull
                     Object value)

Sets a keyed value.

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

Parameters:

key - The value key.

value - The value.

setValuesHidden

public void setValuesHidden(@Nonnull
                            String key)

Sets the values hidden for the specified key.

Parameters:

key - The key.

substitute

@Nonnull
 @CheckReturnValue
public final String substitute(@Nonnull
                                                             String text,
                                                             boolean deferred)

Substitutes markers in a given text.

A substitution marker would be a '${x}' property reference.

Note: when the property ('x') is not found, en empty string is used.

Parameters:

text - The text possibly containing substitution markers.

deferred - True if substitution of '$${x}' should be deferred.

Returns:

The text with markers substituted.

thawed

@Nonnull
 @CheckReturnValue
public KeyedValues thawed()

Returns a thawed instance of this.

Returns:

A clone if frozen, or this.

toString

@Nonnull
 @CheckReturnValue
public String toString()

Overrides:

toString in class Object

addObject

protected final void addObject(@Nonnull
                               String key,
                               @Nonnull
                               Object object)

Adds a keyed object.

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

Parameters:

key - The object key.

object - The object.

checkNotFrozen

protected final void checkNotFrozen()

Checks that this is not frozen.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

setObjects

protected void setObjects(@Nonnull
                          String key,
                          @Nonnull
                          List<Object> objects)

Sets the object list for a key.

Parameters:

key - The object key.

objects - The object list.