Package com.toedter.spring.hateoas.jsonapi

Enum Class JsonApiConfiguration.AffordanceType

java.lang.Object

java.lang.Enum<JsonApiConfiguration.AffordanceType>

com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration.AffordanceType

All Implemented Interfaces:

Serializable, Comparable<JsonApiConfiguration.AffordanceType>, Constable

Enclosing class:

JsonApiConfiguration

public static enum JsonApiConfiguration.AffordanceType
extends Enum<JsonApiConfiguration.AffordanceType>

The list of possible affordance types. Those affordance types are used by JsonApiConfiguration.withAffordancesRenderedAsLinkMeta(com.toedter.spring.hateoas.jsonapi.JsonApiConfiguration.AffordanceType).

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
HAL_FORMS	Affordances will be rendered as link meta (HAL-FORMS format).
NONE	Default, affordances will NOT be rendered as link meta.
SPRING_HATEOAS	Affordances will be rendered as link meta (proprietary format).

Method Summary

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

NONE

public static final JsonApiConfiguration.AffordanceType NONE

Default, affordances will NOT be rendered as link meta.

SPRING_HATEOAS

public static final JsonApiConfiguration.AffordanceType SPRING_HATEOAS

Affordances will be rendered as link meta (proprietary format). The format is close to the internal Spring HATEOAS internal model.

HAL_FORMS

public static final JsonApiConfiguration.AffordanceType HAL_FORMS

Affordances will be rendered as link meta (HAL-FORMS format). See https://rwcbook.github.io/hal-forms/#templates-element.

Method Details

values

public static JsonApiConfiguration.AffordanceType[] 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 JsonApiConfiguration.AffordanceType 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