Enum Class InliningMode

java.lang.Object

java.lang.Enum<InliningMode>

org.incenp.linkml.core.InliningMode

All Implemented Interfaces:

Serializable, Comparable<InliningMode>, Constable

public enum InliningMode
extends Enum<InliningMode>

Represents the various modes of “inlining” instances of a class, in serialisations that do support inlining (e.g. JSON, YAML).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DICT	Instances are inlined as a dictionary.
IRRELEVANT	Inlining is not relevant (typically because the type is not even a class).
LIST	Instances are inlined as a list.
NO_INLINING	Instances are not inlined, but serialised as references instead.

Method Summary

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

IRRELEVANT

public static final InliningMode IRRELEVANT

Inlining is not relevant (typically because the type is not even a class).

NO_INLINING

public static final InliningMode NO_INLINING

Instances are not inlined, but serialised as references instead. This is only possible if their class defines a globally unique identifier.

LIST

public static final InliningMode LIST

Instances are inlined as a list.

DICT

public static final InliningMode DICT

Instances are inlined as a dictionary. This is only possible if their class defines an identifier (globally or locally unique).

Method Details

values

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