Enum Class SerdeConfig.IdReference

java.lang.Object

java.lang.Enum<SerdeConfig.IdReference>

io.micronaut.serde.config.annotation.SerdeConfig.IdReference

All Implemented Interfaces:

Serializable, Comparable<SerdeConfig.IdReference>, Constable

Enclosing class:

SerdeConfig

@Internal
public static enum SerdeConfig.IdReference
extends Enum<SerdeConfig.IdReference>

How a property references beans by their document-scoped identifier.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS_ID	The value, or each element of a collection value, is always written and read as the identifier (JAXB @XmlIDREF, Jackson @JsonIdentityReference(alwaysAsId = true)).
OBJECT_OR_ID	The value is written in full on its first occurrence in the document and as the identifier afterwards; when read, a scalar value is an identifier reference that may precede the referenced object.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALWAYS_ID

public static final SerdeConfig.IdReference ALWAYS_ID

The value, or each element of a collection value, is always written and read as the identifier (JAXB @XmlIDREF, Jackson @JsonIdentityReference(alwaysAsId = true)).

OBJECT_OR_ID

public static final SerdeConfig.IdReference OBJECT_OR_ID

The value is written in full on its first occurrence in the document and as the identifier afterwards; when read, a scalar value is an identifier reference that may precede the referenced object.

Method Details

values

public static SerdeConfig.IdReference[] 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 SerdeConfig.IdReference 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