Package uk.ac.starlink.vo
Class UnitStatus
java.lang.Object
uk.ac.starlink.vo.UnitStatus
Categorises VOUnit validity.
The
getStatus(java.lang.String)
method tests a unit string to determine whether
it conforms to the VOUnits standard.
Norman Gray's Unity library is used for VOUnits parsing.
- Since:
- 9 Jul 2021
- Author:
- Mark Taylor
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Characterises VOUnits standard conformance. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
UnitStatus
(UnitStatus.Code code, String message) Constructor. -
Method Summary
Modifier and TypeMethodDescriptiongetCode()
Returns a status element indicating conformance.Returns a human-readable message supplying additional information.static UnitStatus
Returns the status for a given unit string.
-
Constructor Details
-
UnitStatus
Constructor.- Parameters:
code
- status codemessage
- human-readable message supplying additional information
-
-
Method Details
-
getCode
Returns a status element indicating conformance.- Returns:
- code
-
getMessage
Returns a human-readable message supplying additional information. The returned text does not in general report the original unit string.- Returns:
- message, or null if nothing to say
-
getStatus
Returns the status for a given unit string.- Parameters:
unit
- unit text- Returns:
- status, or null for blank input
-