Package gov.nasa.jpl.aerie.json

Enum Class Unit

java.lang.Object

java.lang.Enum<Unit>

gov.nasa.jpl.aerie.json.Unit

All Implemented Interfaces:

Serializable, Comparable<Unit>, Constable

public enum Unit
extends Enum<Unit>

A type with only one non-null value. This is a convenient alternative to using a null Object in situations where no meaningful information can be communicated, and yet `void` is not an appropriate type, such as in generic contexts.

This type should only be referenced in a JSON parsing context. If a unit type is desired for other purposes, one should be defined for that context specifically. No other component should depend on this library just because it defines this type.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
UNIT

Method Summary

Modifier and Type	Method	Description
static Unit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Unit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNIT

public static final Unit UNIT

Method Details

values

public static Unit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Unit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null