Enum Class ReservationRestController.ReservationRestUriTemplate

java.lang.Object

java.lang.Enum<ReservationRestController.ReservationRestUriTemplate>

de.gustavblass.fsu.fmi.roombooking.controller.ReservationRestController.ReservationRestUriTemplate

All Implemented Interfaces:

Serializable, Comparable<ReservationRestController.ReservationRestUriTemplate>, Constable

Enclosing class:

ReservationRestController

private static enum ReservationRestController.ReservationRestUriTemplate
extends Enum<ReservationRestController.ReservationRestUriTemplate>

Pre-compiled UriTemplates for HATEOAS-compliant API responses. The templates represent relative paths, which the Spring documentation use as well and which RFC 6570 explicitly allows:

A URI Template may be provided in absolute form […] or in relative form.

• ALL_TEMPLATE_PAGED
• SINGLE_TEMPLATE

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_TEMPLATE_PAGED	Matches the path to the ReservationRestController.getReservations(int, int, String, boolean) method with the paging arguments represented as TemplateVariables.
SINGLE_TEMPLATE	Represents the path to the ReservationRestController.getReservation(Long) with the id argument represented as a TemplateVariable.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.springframework.hateoas.UriTemplate	uriTemplate

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ReservationRestUriTemplate(@NonNull org.springframework.hateoas.UriTemplate uriTemplate)

Method Summary

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

ALL_TEMPLATE_PAGED

public static final ReservationRestController.ReservationRestUriTemplate ALL_TEMPLATE_PAGED

Matches the path to the ReservationRestController.getReservations(int, int, String, boolean) method with the paging arguments represented as TemplateVariables.

SINGLE_TEMPLATE

public static final ReservationRestController.ReservationRestUriTemplate SINGLE_TEMPLATE

Represents the path to the ReservationRestController.getReservation(Long) with the id argument represented as a TemplateVariable.

Field Details

uriTemplate

private final org.springframework.hateoas.UriTemplate uriTemplate

Constructor Details

ReservationRestUriTemplate

private ReservationRestUriTemplate(@NonNull
 @NonNull org.springframework.hateoas.UriTemplate uriTemplate)

Method Details

values

public static ReservationRestController.ReservationRestUriTemplate[] 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 ReservationRestController.ReservationRestUriTemplate 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