us.gov.dod.standard.ssrf._3_1.metadata.domains

Class TString

java.lang.Object

us.gov.dod.standard.ssrf._3_1.metadata.AMetadata<TString>

us.gov.dod.standard.ssrf._3_1.metadata.domains.TString

All Implemented Interfaces:

Comparable<TString>

public class TString
extends AMetadata<TString>
implements Comparable<TString>

A simple String instance with SSRF Standard Metadata Attributes. This corresponds to the "xs:string" string type.

Version:

SSRF 3.1.0, 09/29/2014

Author:

Jesse Caulfield

Field Summary

Fields

Modifier and Type	Field and Description
protected String	value The value to which the metadata attributes are associated.

Fields inherited from class us.gov.dod.standard.ssrf._3_1.metadata.AMetadata

availability, cls, extReferences, idref, legacyReleasability, quality, recommendedValue, remarkRef

Constructor Summary

Constructors

Constructor and Description
TString() Empty constructor.
TString(String value) Construct a new data type instance with the indicated value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(TString o) Comparison and sorting is alphabetical based upon the String value.
boolean	equals(Object obj) Equality is based upon the String value.
String	getValue() Gets the value of the value property.
int	hashCode() Hash code is based upon the String value.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetValue() Determine if the Value is configured.
void	setValue(String value) Sets the value of the value property.
String	toString() Get the configured value.
TString	withValue(String value) Sets the value of the value property.

Methods inherited from class us.gov.dod.standard.ssrf._3_1.metadata.AMetadata

getAvailability, getCls, getExtReferences, getIdref, getLegacyReleasability, getQuality, getRecommendedValue, getRemarkRef, isSetAvailability, isSetCls, isSetExtReferences, isSetIdref, isSetLegacyReleasability, isSetQuality, isSetRecommendedValue, isSetRemarkRef, setAvailability, setCls, setIdref, setLegacyReleasability, setQuality, setRecommendedValue, unsetExtReferences, unsetRemarkRef, withAvailability, withCls, withExtReferences, withExtReferences, withIdref, withLegacyReleasability, withQuality, withRecommendedValue, withRemarkRef, withRemarkRef

Methods inherited from class java.lang.Object

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

Field Detail

value

protected String value

The value to which the metadata attributes are associated.

Constructor Detail

TString

public TString(String value)

Construct a new data type instance with the indicated value.

Parameters:

value - the value

TString

public TString()

Empty constructor.

Method Detail

getValue

public String getValue()

Gets the value of the value property.

Returns:

the value of the value property.

setValue

public void setValue(String value)

Sets the value of the value property.

Parameters:

value -

isSetValue

public boolean isSetValue()

Determine if the Value is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

withValue

public TString withValue(String value)

Sets the value of the value property.

Parameters:

value - the value to set

Returns:

this TString instance

isSet

public boolean isSet()

Determine if the required fields in this SSRF data type instance are set.

Requires cls and value

Note that this method only checks for the presence of required information; this method does not validate the information format.

Overrides:

isSet in class AMetadata<TString>

Returns:

TRUE if required fields are set, otherwise FALSE

toString

public String toString()

Get the configured value.

Overrides:

toString in class AMetadata<TString>

Returns:

the value.

hashCode

public int hashCode()

Hash code is based upon the String value.

Overrides:

hashCode in class Object

Returns:

a unique hash code.

equals

public boolean equals(Object obj)

Equality is based upon the String value.

Overrides:

equals in class Object

Parameters:

obj - the other object

Returns:

TRUE if the string values match.

compareTo

public int compareTo(TString o)

Comparison and sorting is alphabetical based upon the String value.

Specified by:

compareTo in interface Comparable<TString>

Parameters:

o - the other TString value

Returns:

alphabetical sort order