@NonNullApi

Package org.springframework.hateoas

Value objects to ease creating Links and link driven representations for REST webservices.

See: Description

Interface Summary

Interface	Description
AffordanceModel.InputPayloadMetadata	Payload metadata for incoming requests.
AffordanceModel.Named	A named component.
AffordanceModel.PayloadMetadata	Metadata about payloads.
AffordanceModel.PropertyMetadata	Metadata about the property model of a representation.
AffordanceModel.PropertyMetadataConfigured<T>	SPI for a type that can get AffordanceModel.PropertyMetadata applied.
LinkRelation	Interface for defining link relations.

Class Summary

Class	Description
Affordance	Hold the AffordanceModels for all supported media types.
AffordanceModel	Collection of attributes needed to render any form of hypermedia.
CollectionModel<T>	General helper to easily create a wrapper for a collection of entities.
EntityModel<T>	A simple EntityModel wrapping a domain object and adding links to it.
IanaLinkRelations	Capture standard IANA-based link relations.
IanaUriSchemes	A list of well-defined URI schemes governed by IANA.
Link	Value object for links.
Links	Value object to represent a list of Links.
MediaTypes	Constants for well-known hypermedia types.
PagedModel<T>	DTO to implement binding response representations of pageable collections.
PagedModel.PageMetadata	Value object for pagination metadata.
QueryParameter	Representation of a web request's query parameter (https://example.com?
RepresentationModel<T extends RepresentationModel<? extends T>>	Base class for DTOs to collect links.
TemplateVariable	A single template variable.
TemplateVariables	Wrapper type for a collection of TemplateVariable.
UriTemplate	Custom URI template to support qualified URI template variables.

Enum Summary

Enum	Description
Links.MergeMode	The mode how to merge two Links instances.
TemplateVariable.Cardinality	The cardinality of the TemplateVariable.
TemplateVariable.VariableType	An enumeration for all supported variable types.

Annotation Types Summary

Annotation Type	Description
InputType	Annotation to declare a dedicated input type for a property of an representation model.
NonComposite	Annotation to be used in combination with RequestParam to indicate that collection based values are supposed to be rendered as non-composite values, i.e. like param=value1,value2,value3 rather than param=value1&param=value2 when generating links by pointing to controller methods.

Package org.springframework.hateoas Description

Value objects to ease creating Links and link driven representations for REST webservices.

Author:

Oliver Drotbohm, Jens Schauder, Greg Turnquist