org.pfsw.util

Class NamedValue<V>

java.lang.Object

org.pfsw.util.Association<java.lang.String,V>

org.pfsw.util.NamedValue<V>

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, java.util.Map.Entry<java.lang.String,V>

Direct Known Subclasses:

NamedText

public class NamedValue<V>
extends Association<java.lang.String,V>
implements java.lang.Comparable

This specialized Association allows only strings as key.
Access to key and value is provided by

• name()
• name( newName )
• value()
• value( newValue )

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NamedValue(java.lang.String name) Initialize the new instance with a name and a null value.
NamedValue(java.lang.String name, V value) Initialize the new instance with a name and an associated value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object obj) Compares this object with the specified object for order.
NamedValue<V>	copyNamedValue() Returns a copy of this object
void	key(java.lang.String newKey) Sets the new key.
java.lang.String	name() Returns the name (key) of the association.
void	name(java.lang.String newName) Sets the name (key) of the association.
static <T> NamedValue<T>	of(java.lang.String name, T value) Creates a new instance with a name and an associated value.

Methods inherited from class org.pfsw.util.Association

copyAssociation, equals, getKey, getValue, hashCode, key, setValue, toString, value, value

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

NamedValue

public NamedValue(java.lang.String name)

Initialize the new instance with a name and a null value. If name is null it will be transformed to an empty String ("").

NamedValue

public NamedValue(java.lang.String name,
                  V value)

Initialize the new instance with a name and an associated value. If name is null it will be transformed to an empty String ("").

Method Detail

of

public static <T> NamedValue<T> of(java.lang.String name,
                                   T value)

Creates a new instance with a name and an associated value. If name is null it will be transformed to an empty String (""). This is just a convenience factory method.

key

public void key(java.lang.String newKey)

Sets the new key. A null key will be ignored.

Overrides:

key in class Association<java.lang.String,V>

name

public void name(java.lang.String newName)

Sets the name (key) of the association.

Parameters:

newName - The new key (must not be null !)

name

public java.lang.String name()

Returns the name (key) of the association.

compareTo

public int compareTo(java.lang.Object obj)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Here the comparison will be done on the names of the NamedValue objects.

Specified by:

compareTo in interface java.lang.Comparable

copyNamedValue

public NamedValue<V> copyNamedValue()

Returns a copy of this object