org.springframework.hateoas

Enum TemplateVariable.Cardinality

java.lang.Object

java.lang.Enum<TemplateVariable.Cardinality>

org.springframework.hateoas.TemplateVariable.Cardinality

All Implemented Interfaces:

Serializable, Comparable<TemplateVariable.Cardinality>

Enclosing class:

TemplateVariable

public static enum TemplateVariable.Cardinality
extends Enum<TemplateVariable.Cardinality>

The cardinality of the TemplateVariable.

Since:

1.4

Author:

Oliver Drotbohm

See Also:

https://datatracker.ietf.org/doc/html/rfc6570#section-2.4.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPOSITE
SINGULAR

Method Summary

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

SINGULAR

public static final TemplateVariable.Cardinality SINGULAR

COMPOSITE

public static final TemplateVariable.Cardinality COMPOSITE

Method Detail

values

public static TemplateVariable.Cardinality[] 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 (TemplateVariable.Cardinality c : TemplateVariable.Cardinality.values())
    System.out.println(c);

Returns:

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

valueOf

public static TemplateVariable.Cardinality 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