Package com.kazforge.jsonapi.document

Enum Class PrimaryDataKind

java.lang.Object

java.lang.Enum<PrimaryDataKind>

com.kazforge.jsonapi.document.PrimaryDataKind

All Implemented Interfaces:

Serializable, Comparable<PrimaryDataKind>, Constable

public enum PrimaryDataKind
extends Enum<PrimaryDataKind>

Explicit interpretation of top-level primary data objects and arrays.

Minimal resource and resource-identifier JSON forms can be identical ({"type","id"} and []). Callers must choose the kind; the reader never guesses from object members.

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
RESOURCE	Decode primary data as ResourceObject / resource collections.
RESOURCE_IDENTIFIER	Decode primary data as ResourceIdentifier / identifier collections.

Method Summary

Modifier and Type	Method	Description
static PrimaryDataKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PrimaryDataKind[]	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

RESOURCE

public static final PrimaryDataKind RESOURCE

Decode primary data as ResourceObject / resource collections.

RESOURCE_IDENTIFIER

public static final PrimaryDataKind RESOURCE_IDENTIFIER

Decode primary data as ResourceIdentifier / identifier collections.

Method Details

values

public static PrimaryDataKind[] 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 PrimaryDataKind 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