org.pfsw.util

Class NamedText

java.lang.Object

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

org.pfsw.util.NamedValue<java.lang.String>

org.pfsw.util.NamedText

All Implemented Interfaces:

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

public class NamedText
extends NamedValue<java.lang.String>
implements IMutableStringPair

An association of a name string and a text value. Both, name and value can never be null!
Access to key and value is provided by

• name()
• name( newName )
• text()
• text( newText )

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.pfsw.bif.text.IStringPair

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
NamedText(java.lang.String name, java.lang.String text) Initialize the new instance with the given name and value.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	asArray() Returns both strings of this pair in a String array.
java.lang.String	asString(java.lang.String separator) Returns the two strings as one string separated by the given separator.
NamedText	copy() Returns a copy of this object
NamedText	copyNamedText() Returns a copy of this object
java.lang.String	getString1() Returns the first string of this pair.
java.lang.String	getString2() Returns the second string of this pair.
static NamedText	of(java.lang.String name, java.lang.String text) Creates a new instance with a name and an associated text.
void	setString1(java.lang.String string) Sets the first string to the given value.
void	setString2(java.lang.String string) Sets the second string to the given value.
java.lang.String	text() Returns the text (value) of the association.
void	text(java.lang.String newText) Sets the text (value) of the association.
void	value(java.lang.String newText) Sets the text (value) of the association.

Methods inherited from class org.pfsw.util.NamedValue

compareTo, copyNamedValue, key, name, name

Methods inherited from class org.pfsw.util.Association

copyAssociation, equals, getKey, getValue, hashCode, key, setValue, toString, 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

NamedText

public NamedText(java.lang.String name,
                 java.lang.String text)

Initialize the new instance with the given name and value. Both, name and value must not be null. If any of them is null it will be automatically translated to an empty String ("").

Method Detail

of

public static NamedText of(java.lang.String name,
                           java.lang.String text)

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

value

public void value(java.lang.String newText)

Sets the text (value) of the association.

Overrides:

value in class Association<java.lang.String,java.lang.String>

Parameters:

newText - The new text (a null value will be ignored)

text

public void text(java.lang.String newText)

Sets the text (value) of the association.

Parameters:

newText - The new text (a null value will be ignored)

text

public java.lang.String text()

Returns the text (value) of the association.

copy

public NamedText copy()

Returns a copy of this object

copyNamedText

public NamedText copyNamedText()

Returns a copy of this object

getString1

public java.lang.String getString1()

Description copied from interface: IStringPair

Returns the first string of this pair.

Specified by:

getString1 in interface IStringPair

setString1

public void setString1(java.lang.String string)

Description copied from interface: IMutableStringPair

Sets the first string to the given value.

Specified by:

setString1 in interface IMutableStringPair

Parameters:

string - The new value (may be null).

getString2

public java.lang.String getString2()

Description copied from interface: IStringPair

Returns the second string of this pair.

Specified by:

getString2 in interface IStringPair

setString2

public void setString2(java.lang.String string)

Description copied from interface: IMutableStringPair

Sets the second string to the given value.

Specified by:

setString2 in interface IMutableStringPair

Parameters:

string - The new value (may be null).

asArray

public java.lang.String[] asArray()

Description copied from interface: IStringPair

Returns both strings of this pair in a String array.

Specified by:

asArray in interface IStringPair

asString

public java.lang.String asString(java.lang.String separator)

Description copied from interface: IStringPair

Returns the two strings as one string separated by the given separator. If the provided separator is null, no separator should be put between the strings.

Specified by:

asString in interface IStringPair

Parameters:

separator - A separator to be placed between the two strings.