Package org.springframework.hateoas.mediatype.hal

Enum Class HalConfiguration.RenderSingleLinks

java.lang.Object

java.lang.Enum<HalConfiguration.RenderSingleLinks>

org.springframework.hateoas.mediatype.hal.HalConfiguration.RenderSingleLinks

All Implemented Interfaces:

Serializable, Comparable<HalConfiguration.RenderSingleLinks>, Constable

Enclosing class:

HalConfiguration

public static enum HalConfiguration.RenderSingleLinks
extends Enum<HalConfiguration.RenderSingleLinks>

Configuration option how to render single links of a given LinkRelation.

Author:

Oliver Drotbohm

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
AS_ARRAY	A single Link is rendered as a JSON Array.
AS_SINGLE	A single Link is rendered as a JSON object.

Method Summary

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

AS_SINGLE

public static final HalConfiguration.RenderSingleLinks AS_SINGLE

A single Link is rendered as a JSON object.

AS_ARRAY

public static final HalConfiguration.RenderSingleLinks AS_ARRAY

A single Link is rendered as a JSON Array.

Method Details

values

public static HalConfiguration.RenderSingleLinks[] 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 HalConfiguration.RenderSingleLinks 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