org.protempa.proposition.value

Class NominalValue

java.lang.Object

org.protempa.proposition.value.NominalValue

All Implemented Interfaces:

Serializable, Comparable<NominalValue>, Value, ValueVisitable

public final class NominalValue
extends Object
implements Value, Comparable<NominalValue>, Serializable

Represents a String value.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NominalValue(String val) Creates a new nominal value with the given value.

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor valueVisitor) Performs some processing on a value.
NominalValueBuilder	asBuilder()
ValueComparator	compare(Value o) Compares this nominal value and another lexically.
int	compareTo(NominalValue t)
boolean	equals(Object obj) Compares this nominal value and another for string equality.
String	format(Format format) Returns a string representing this value, formatted by the provided Format.
String	getFormatted() Returns the same thing as getString().
static NominalValue	getInstance(String val) Creates a new nominal value.
String	getString() Gets the value as a Java String.
ValueType	getType() Returns this object's type, guaranteed not null.
int	hashCode()
NominalValue	replace() Returns a value from a cache that is equal to this one, if such a value exists.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NominalValue

public NominalValue(String val)

Creates a new nominal value with the given value. The recommended way to create nominal values is with getInstance(java.lang.String).

Parameters:

val - a String. If null, the default string is used ("").

Method Detail

getInstance

public static NominalValue getInstance(String val)

Creates a new nominal value. If val's length is less than 20 characters, the created NominalValue object will be cached and reused.

Parameters:

val - a String. If null, NominalValue with "" will be created.

Returns:

a NominalValue.

replace

public NominalValue replace()

Description copied from interface: Value

Returns a value from a cache that is equal to this one, if such a value exists. Otherwise, it returns itself.

Specified by:

replace in interface Value

Returns:

a Value for which #equals(Value) is true.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Compares this nominal value and another for string equality.

Overrides:

equals in class Object

Parameters:

obj - another object.

Returns:

true if the two nominal values' strings are equal, false if not.

getString

public String getString()

Gets the value as a Java String.

Returns:

a String.

getFormatted

public String getFormatted()

Returns the same thing as getString().

Specified by:

getFormatted in interface Value

Returns:

a String. Guaranteed not null.

format

public String format(Format format)

Description copied from interface: Value

Returns a string representing this value, formatted by the provided Format.

Specified by:

format in interface Value

Parameters:

format - a Format. Passing in a null will result in the same behavior as Value.getFormatted().

Returns:

a String.

getType

public ValueType getType()

Description copied from interface: Value

Returns this object's type, guaranteed not null.

Specified by:

getType in interface Value

Returns:

a ValueType.

compare

public ValueComparator compare(Value o)

Compares this nominal value and another lexically. If the argument is a ListValue, it checks this string for membership in the list.

Specified by:

compare in interface Value

Parameters:

o - another Value.

Returns:

If the provided value is a NominalValue, returns null ValueComparator.GREATER_THAN, ValueComparator.LESS_THAN or ValueComparator.EQUAL_TO depending on whether this nominal value is lexically greater than, less than or equal to the nominal value provided as argument. If the provided value is a ValueList, returns ValueComparator.IN if this object is a member of the list, or ValueComparator.NOT_IN if not. Otherwise, returns ValueComparator.UNKNOWN.

accept

public void accept(ValueVisitor valueVisitor)

Description copied from interface: ValueVisitable

Performs some processing on a value.

Specified by:

accept in interface ValueVisitable

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(NominalValue t)

Specified by:

compareTo in interface Comparable<NominalValue>

asBuilder

public NominalValueBuilder asBuilder()

Specified by:

asBuilder in interface Value