Package com.apicatalog.jsonld

Enum JsonLdEmbed

java.lang.Object

java.lang.Enum<JsonLdEmbed>

com.apicatalog.jsonld.JsonLdEmbed

All Implemented Interfaces:

Serializable, Comparable<JsonLdEmbed>

public enum JsonLdEmbed
extends Enum<JsonLdEmbed>

See Also:

JsonLdEmbed

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Always embed node objects as property values, unless this would cause a circular reference.
NEVER	Always use a node reference when serializing matching values.
ONCE	Only a single value within a given node object should be embedded, other values of other properties use a node reference.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS

public static final JsonLdEmbed ALWAYS

Always embed node objects as property values, unless this would cause a circular reference.

NEVER

public static final JsonLdEmbed NEVER

Always use a node reference when serializing matching values.

ONCE

public static final JsonLdEmbed ONCE

Only a single value within a given node object should be embedded, other values of other properties use a node reference. This is the default value if neither @embed nor object embed flag is specified.

Method Detail

values

public static JsonLdEmbed[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JsonLdEmbed c : JsonLdEmbed.values())
    System.out.println(c);

Returns:

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

valueOf

public static JsonLdEmbed valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null