org.rvpf.base

Class Params

Object

KeyedValues

Params

All Implemented Interfaces:

Serializable

@NotThreadSafe
public final class Params
extends KeyedValues

Dictionary of parameters.

Params may hold any number of parameters. Each parameter is a key associated with one value or more. The order of parameters within the dictionary is unspecified, but the values of a parameter are in their order of insertion.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Params	EMPTY_PARAMS Empty parameters.

Fields inherited from class KeyedValues

ANONYMOUS, HASH_LOAD_FACTOR, MAP_ENTRY_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
Params() Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	containsValueKey(String key) Asks if the key is associated with a value.
Params	copy() Creates a copy of this.
boolean	equals(Object other)
Params	freeze() Freezes this.
List<Object>	getObjects(String key) Gets the object list for a key.
int	hashCode()
void	setDefaults(Params defaults) Sets the defaults.

Methods inherited from class KeyedValues

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

Methods inherited from class Object

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

Field Detail

EMPTY_PARAMS

public static final Params EMPTY_PARAMS

Empty parameters.

Constructor Detail

Params

public Params()

Constructs an instance.

Method Detail

containsValueKey

public 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 Params 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 Params freeze()

Freezes this.

Overrides:

freeze in class KeyedValues

Returns:

This.

getObjects

public 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).

hashCode

public int hashCode()

Overrides:

hashCode in class KeyedValues

setDefaults

public void setDefaults(@Nonnull
                        Params defaults)

Sets the defaults.

Parameters:

defaults - The defaults.