org.protempa.valueset

Class ValueSetElement

java.lang.Object

org.protempa.valueset.ValueSetElement

public final class ValueSetElement
extends Object

For specifying the values of a value set.

Constructor Summary

Constructors

Constructor and Description
ValueSetElement(Value value)
ValueSetElement(Value value, String displayName)
ValueSetElement(Value value, String displayName, String abbrevDisplayName)
ValueSetElement(Value value, String displayName, String abbrevDisplayName, Attribute[] attributes) Instantiates a value of a value set.

Method Summary

Modifier and Type	Method and Description
ValueSetElementBuilder	asBuilder()
String	getAbbrevDisplayName() Returns the value's abbreviated display name.
Attribute[]	getAttributes()
String	getDisplayName() Returns the value's display name.
Value	getValue() Returns the value.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueSetElement

public ValueSetElement(Value value)

ValueSetElement

public ValueSetElement(Value value,
                       String displayName)

ValueSetElement

public ValueSetElement(Value value,
                       String displayName,
                       String abbrevDisplayName)

ValueSetElement

public ValueSetElement(Value value,
                       String displayName,
                       String abbrevDisplayName,
                       Attribute[] attributes)

Instantiates a value of a value set.

Parameters:

value - the Value. Cannot be null.

displayName - the value's display name String. If null is specified, getDisplayName() will return the empty string.

abbrevDisplayName - the value's abbreviated display name String. If null is specified, getAbbrevDisplayName() will return the empty string.

Method Detail

getAbbrevDisplayName

public String getAbbrevDisplayName()

Returns the value's abbreviated display name. Guaranteed not null.

Returns:

a String.

getDisplayName

public String getDisplayName()

Returns the value's display name. Guaranteed not null.

Returns:

a String.

getValue

public Value getValue()

Returns the value. Guaranteed not null.

Returns:

a Value.

getAttributes

public Attribute[] getAttributes()

toString

public String toString()

Overrides:

toString in class Object

asBuilder

public ValueSetElementBuilder asBuilder()