Class NilReason
- All Implemented Interfaces:
Serializable
valueOf(String) and toString() methods respectively.
The string can be either a URI or an enumeration value described below.
More specifically, NilReason can be:
- One of the predefined
INAPPLICABLE,MISSING,TEMPLATE,UNKNOWNorWITHHELDenumeration values. - The
OTHERenumeration value, or a new enumeration value formatted as"other:"concatenated with a brief textual explanation. - A URI which should refer to a resource which describes the reason for the exception.
NilReason is used in a number of XML elements where it is necessary to permit
one of the above values as an alternative to the primary element.
Immutability and thread safety
This final class is immutable and thus inherently thread-safe.- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final NilReasonThere is no value.static final NilReasonThe correct value is not readily available to the sender of this data.static final NilReasonOther reason without explanation.static final NilReasonThe value will be available later.static final NilReasonThe correct value is not known to, and not computable by, the sender of this data.static final NilReasonThe value is not divulged. -
Method Summary
Modifier and TypeMethodDescription<T> TcreateNilObject(Class<T> type) Returns an object of the given type which is nil for the reason represented by this instance.booleanCompares thisNilReasonwith the specified object for equality.static NilReasonforObject(Object object) If the given object is nil, returns the reason why it does not contain information.If thisNilReasonis an enumeration of kindOTHER, returns the explanation text.getURI()If the explanation of thisNilReasonis referenced by a URI, returns that URI.intReturns a hash code value for thisNilReason.Returns the GML string representation of thisNilReason.static NilReasonParses the given nil reason.static NilReason[]values()Returns an array containing every instances of this type that have not yet been garbage collected.
-
Field Details
-
INAPPLICABLE
There is no value.The string representation is
"inapplicable". Other properties (explanation and URI) arenull. -
MISSING
The correct value is not readily available to the sender of this data. Furthermore, a correct value may not exist.The string representation is
"missing". Other properties (explanation and URI) arenull. -
TEMPLATE
The value will be available later.The string representation is
"template". Other properties (explanation and URI) arenull. -
UNKNOWN
The correct value is not known to, and not computable by, the sender of this data. However, a correct value probably exists.The string representation is
"unknown". Other properties (explanation and URI) arenull. -
WITHHELD
The value is not divulged.The string representation is
"withheld". Other properties (explanation and URI) arenull. -
OTHER
Other reason without explanation. The string representation of this constant is"other". The explanation property is an empty string, and the URI isnull.Providing an explanation
Users are encouraged to use thevalueOf(String)method instead of this constant, in order to provide a brief explanation. The string representation forvalueOf(…)is"other:explanation"where explanation is a string of two or more characters with no included spaces.When testing if a
NilReasoninstance is any kind of"other"reason, users should test ifgetOtherExplanation() != nullinstead than comparing the reference against this constant.
-
-
Method Details
-
values
Returns an array containing every instances of this type that have not yet been garbage collected. The first elements of the returned array are the constants defined in this class, in declaration order. All other elements are the instances created by thevalueOf(String)method, in no particular order.- Returns:
- an array containing the instances of
NilReason.
-
valueOf
Parses the given nil reason. This method accepts the following cases:- If the given argument is one of the
"inapplicable","missing","template","unknown","withheld"or"other"strings (ignoring cases and leading/trailing spaces), then the corresponding predefined constant is returned. - Otherwise if the given argument is
"other:"followed by an explanation text, then an instance for that explanation is returned. More specifically:- Space characters and ISO controls are silently omitted.
- If the remaining string has less than two characters, then the
OTHERconstant is returned.
- Otherwise this method attempts to parse the given argument as a
URI. Such URI should refer to a resource which describes the reason for the exception.
- Parameters:
reason- the reason why an element is not present.- Returns:
- the reason as a
NilReasonobject. - Throws:
URISyntaxException- if the given string is not one of the predefined enumeration values and cannot be parsed as a URI.
- If the given argument is one of the
-
getOtherExplanation
If thisNilReasonis an enumeration of kindOTHER, returns the explanation text. Otherwise returnsnull. If non-null, then the explanation is a string without whitespace.Note that in the special case where
thisnil reason is theOTHERinstance itself, then this method returns an empty string. For all other cases, the string contains at least two characters.- Returns:
- the explanation, or
nullif thisNilReasonis not of kindOTHER.
-
getURI
If the explanation of thisNilReasonis referenced by a URI, returns that URI. Otherwise returnsnull. The URI and the other explanation attributes are mutually exclusive.- Returns:
- the URI, or
nullif the explanation of thisNilReasonis not referenced by a URI.
-
toString
Returns the GML string representation of thisNilReason. The returned string is a simple enumeration value (e.g."inapplicable") if thisNilReasonis one of the predefined constants, or a string of the form"other:explanation", or a URI. -
hashCode
public int hashCode()Returns a hash code value for thisNilReason. -
equals
Compares thisNilReasonwith the specified object for equality. -
createNilObject
Returns an object of the given type which is nil for the reason represented by this instance. Thetypeargument can be one of the following cases:- An interface: in such case, this method returns an object which implement the given
interface together with the
NilObjectandLenientComparableinterfaces:- The
NilObject.getNilReason()method will return thisNilReasoninstance. - The
equals(…)andhashCode()methods behave as documented inLenientComparable. - The
toString()method is unspecified (may contain debugging information). - All other methods return an empty collections, empty arrays,
null,NaN,0orfalse, in this preference order, depending on the method return type.
- The
- One of
Boolean,Byte,Short,Integer,Long,Float,DoubleorStringtypes: in such case, this method returns a specific instance which will be recognized as "nil" by the XML marshaller.
- Type Parameters:
T- the compile-time type of thetypeargument.- Parameters:
type- the object type as an interface (usually a GeoAPI one) or one of the special types.- Returns:
- an
NilObjectof the given type. - Throws:
IllegalArgumentException- if the given type is not a supported type.
- An interface: in such case, this method returns an object which implement the given
interface together with the
-
forObject
If the given object is nil, returns the reason why it does not contain information. This method performs the following choices:- If the given object implements the
NilObjectinterface, then this method delegates to theNilObject.getNilReason()method. - Otherwise if the given object is one of the
Boolean,Byte,Short,Integer,Long,Float,DoubleorStringinstances returned bycreateNilObject(Class), then this method returns the associated reason. - Otherwise this method returns
null.
- Parameters:
object- the object for which to get theNilReason, ornull.- Returns:
- the reason why the given object contains no information, or
nullif the given object is not nil. - Since:
- 0.4
- See Also:
- If the given object implements the
-