Enum Class RoomRestController.RoomRestUriTemplate

java.lang.Object

java.lang.Enum<RoomRestController.RoomRestUriTemplate>

de.gustavblass.fsu.fmi.roombooking.controller.RoomRestController.RoomRestUriTemplate

All Implemented Interfaces:

Serializable, Comparable<RoomRestController.RoomRestUriTemplate>, Constable

Enclosing class:

RoomRestController

private static enum RoomRestController.RoomRestUriTemplate
extends Enum<RoomRestController.RoomRestUriTemplate>

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
• SINGLE_TEMPLATE
• SCHEDULE_TEMPLATE

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_TEMPLATE	Matches the path to the RoomRestController.getRooms(int, int, String, boolean) method with the arguments represented as TemplateVariables.
SCHEDULE_TEMPLATE	Represents the path to the RoomRestController.getRoomSchedule(String, LocalDate, LocalTime, LocalTime) method with the arguments represented as TemplateVariables.
SINGLE_TEMPLATE	Represents the path to the RoomRestController.getRoom(String) with the number 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	RoomRestUriTemplate(@NonNull org.springframework.hateoas.UriTemplate uriTemplate)

Method Summary

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

public static final RoomRestController.RoomRestUriTemplate ALL_TEMPLATE

Matches the path to the RoomRestController.getRooms(int, int, String, boolean) method with the arguments represented as TemplateVariables.

SINGLE_TEMPLATE

public static final RoomRestController.RoomRestUriTemplate SINGLE_TEMPLATE

Represents the path to the RoomRestController.getRoom(String) with the number argument represented as a TemplateVariable.

SCHEDULE_TEMPLATE

public static final RoomRestController.RoomRestUriTemplate SCHEDULE_TEMPLATE

Represents the path to the RoomRestController.getRoomSchedule(String, LocalDate, LocalTime, LocalTime) method with the arguments represented as TemplateVariables.

Field Details

uriTemplate

private final org.springframework.hateoas.UriTemplate uriTemplate

Constructor Details

RoomRestUriTemplate

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

Method Details

values

public static RoomRestController.RoomRestUriTemplate[] 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 RoomRestController.RoomRestUriTemplate 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