Skip navigation links
Spring HATEOAS
A B C D E F G H I J K L M N O P Q R S T U V W _ 

A

ABOUT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that is the subject of the link's context.
AbstractEntityLinks - Class in org.springframework.hateoas.server.core
Implementation base class to delegate the higher level methods of EntityLinks by delegating to the more fine grained ones to reduce the implementation effort for actual implementation classes.
AbstractEntityLinks() - Constructor for class org.springframework.hateoas.server.core.AbstractEntityLinks
 
acceptJsonFormatVisitor(JsonFormatVisitorWrapper, JavaType) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
add(VndErrors.VndError) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Adds an additional VndErrors.VndError to the wrapper.
add(Link) - Method in class org.springframework.hateoas.RepresentationModel
Adds the given link to the resource.
add(Iterable<Link>) - Method in class org.springframework.hateoas.RepresentationModel
Adds all given Links to the resource.
add(Link...) - Method in class org.springframework.hateoas.RepresentationModel
Adds all given Links to the resource.
addAffordances(Collection<Affordance>) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
addLinks(EntityModel<T>, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.SimpleReactiveRepresentationModelAssembler
Define links to add to every individual EntityModel.
addLinks(CollectionModel<EntityModel<T>>, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.SimpleReactiveRepresentationModelAssembler
Define links to add to the CollectionModel collection.
addLinks(EntityModel<T>) - Method in interface org.springframework.hateoas.server.SimpleRepresentationModelAssembler
Define links to add to every individual EntityModel.
addLinks(CollectionModel<EntityModel<T>>) - Method in interface org.springframework.hateoas.server.SimpleRepresentationModelAssembler
Define links to add to the CollectionModel collection.
afford(Object) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Extract a Link from the ControllerLinkBuilder and look up the related Affordance.
afford(Object) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
Extract a Link from the WebMvcLinkBuilder and look up the related Affordance.
Affordance - Class in org.springframework.hateoas
Hold the AffordanceModels for all supported media types.
Affordance(String, Link, HttpMethod, ResolvableType, List<QueryParameter>, ResolvableType) - Constructor for class org.springframework.hateoas.Affordance
Creates a new Affordance.
AffordanceModel - Class in org.springframework.hateoas
Collection of attributes needed to render any form of hypermedia.
AffordanceModel() - Constructor for class org.springframework.hateoas.AffordanceModel
 
AffordanceModelFactory - Interface in org.springframework.hateoas
 
afterPropertiesSet() - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
 
afterPropertiesSet() - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvokingHandlerAdapter
 
Alps - Class in org.springframework.hateoas.mediatype.alps
An ALPS document.
Alps() - Constructor for class org.springframework.hateoas.mediatype.alps.Alps
 
ALPS_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/alps+json.
ALPS_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.ALPS_JSON.
AlpsLinkDiscoverer - Class in org.springframework.hateoas.mediatype.alps
LinkDiscoverer implementation to find ALPS-based links.
AlpsLinkDiscoverer() - Constructor for class org.springframework.hateoas.mediatype.alps.AlpsLinkDiscoverer
 
ALTERNATE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a substitute for this context
and(Link...) - Method in class org.springframework.hateoas.Links
Creates a new Links instance with all given Links added.
and(Iterable<Link>) - Method in class org.springframework.hateoas.Links
Creates a new Links instance with all given Links added.
andAffordance(Affordance) - Method in class org.springframework.hateoas.Link
Create new Link with an additional Affordance.
andAffordance(String, HttpMethod, ResolvableType, List<QueryParameter>, ResolvableType) - Method in class org.springframework.hateoas.Link
Convenience method when chaining an existing Link.
andAffordance(HttpMethod, ResolvableType, List<QueryParameter>, ResolvableType) - Method in class org.springframework.hateoas.Link
Convenience method when chaining an existing Link.
andAffordance(HttpMethod, Class<?>, List<QueryParameter>, Class<?>) - Method in class org.springframework.hateoas.Link
Convenience method when chaining an existing Link.
andAffordance(Object) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
Adds the affordance created by the given virtual method invocation.
andAffordances(List<Affordance>) - Method in class org.springframework.hateoas.Link
Create new Link with additional Affordances.
andContentType(MediaType) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsTemplate
Returns a new HalFormsTemplate with the given MediaType added as content type.
andEmbedded(HalLinkRelation, Object) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
Adds the given value as embedded one.
andLink(Link) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
Adds the given Link to the current document.
andProperty(HalFormsProperty) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsTemplate
Returns a new HalFormsTemplate with the given HalFormsProperty added.
andTemplate(String, HalFormsTemplate) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
Adds the given HalFormsTemplate to the current document.
AnnotationAttribute - Class in org.springframework.hateoas.server.core
Simply helper to reference a dedicated attribute of an Annotation.
AnnotationAttribute(Class<? extends Annotation>) - Constructor for class org.springframework.hateoas.server.core.AnnotationAttribute
Creates a new AnnotationAttribute to the value attribute of the given Annotation type.
AnnotationAttribute(Class<? extends Annotation>, String) - Constructor for class org.springframework.hateoas.server.core.AnnotationAttribute
Creates a new AnnotationAttribute for the given Annotation type and annotation attribute name.
AnnotationLinkRelationProvider - Class in org.springframework.hateoas.server.core
 
AnnotationLinkRelationProvider() - Constructor for class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
 
AnnotationMappingDiscoverer - Class in org.springframework.hateoas.server.core
MappingDiscoverer implementation that inspects mappings from a particular annotation.
AnnotationMappingDiscoverer(Class<? extends Annotation>) - Constructor for class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Creates an AnnotationMappingDiscoverer for the given annotation type.
AnnotationMappingDiscoverer(Class<? extends Annotation>, String) - Constructor for class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Creates an AnnotationMappingDiscoverer for the given annotation type and attribute name.
APPENDIX - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to an appendix.
ARCHIVES - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a collection of records, documents, or other materials of historical interest.
asLink() - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Returns the Link found for the last rel in the rels configured to follow.
asList() - Method in class org.springframework.hateoas.TemplateVariables
Returns the contained TemplateVariables as List.
asTemplatedLink() - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Returns the templated Link found for the last rel in the rels configured to follow.
ATOM_NAMESPACE - Static variable in class org.springframework.hateoas.Link
 
AUTHOR - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the context's author.

B

BLOCKED_BY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies the entity that blocks access to a resource following receipt of a legal demand.
BOOKMARK - Static variable in class org.springframework.hateoas.IanaLinkRelations
Gives a permanent link to use for bookmarking purposes.

C

CachingMappingDiscoverer - Class in org.springframework.hateoas.server.core
Caching adapter of MappingDiscoverer.
CachingMappingDiscoverer() - Constructor for class org.springframework.hateoas.server.core.CachingMappingDiscoverer
 
canBeCombinedWith(TemplateVariable.VariableType) - Method in enum org.springframework.hateoas.TemplateVariable.VariableType
 
CANONICAL - Static variable in class org.springframework.hateoas.IanaLinkRelations
Designates the preferred version of a resource (the IRI and its contents).
canRead(Class<?>, MediaType) - Method in class org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
 
canRead(Type, Class<?>, MediaType) - Method in class org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
 
canWrite(Class<?>, MediaType) - Method in class org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
 
CHAPTER - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a chapter in a collection of resources.
CITE_AS - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates that the link target is preferred over the link context for the purpose of referencing.
COLLECTION - Static variable in class org.springframework.hateoas.IanaLinkRelations
The target IRI points to a resource which represents the collection resource for the context IRI.
COLLECTION_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/vnd.collection+json.
COLLECTION_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.COLLECTION_JSON.
CollectionJsonLinkDiscoverer - Class in org.springframework.hateoas.mediatype.collectionjson
LinkDiscoverer implementation based on JSON Collection link structure.
CollectionJsonLinkDiscoverer() - Constructor for class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
 
CollectionModel<T> - Class in org.springframework.hateoas
General helper to easily create a wrapper for a collection of entities.
CollectionModel() - Constructor for class org.springframework.hateoas.CollectionModel
Creates an empty CollectionModel instance.
CollectionModel(Iterable<T>, Link...) - Constructor for class org.springframework.hateoas.CollectionModel
Creates a CollectionModel instance with the given content and Links (optional).
CollectionModel(Iterable<T>, Iterable<Link>) - Constructor for class org.springframework.hateoas.CollectionModel
Creates a CollectionModel instance with the given content and Links.
CollectionModelType() - Constructor for class org.springframework.hateoas.server.core.TypeReferences.CollectionModelType
 
collector() - Static method in class org.springframework.hateoas.Links
Creates a new Collector to collect a Stream of Links into a Links instance.
concat(TemplateVariable...) - Method in class org.springframework.hateoas.TemplateVariables
Concatenates the given TemplateVariables to the current one.
concat(Collection<TemplateVariable>) - Method in class org.springframework.hateoas.TemplateVariables
Concatenates the given TemplateVariables to the current one.
concat(TemplateVariables) - Method in class org.springframework.hateoas.TemplateVariables
Concatenates the given TemplateVariables to the current one.
configureObjectMapper(ObjectMapper) - Method in interface org.springframework.hateoas.config.HypermediaMappingInformation
Configure an ObjectMapper and register custom serializers and deserializers for the supported media types.
configureObjectMapper(ObjectMapper) - Method in class org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration
 
contains(Link...) - Method in class org.springframework.hateoas.Links
Returns whether the current Links contain all given Links (but potentially others).
contains(Iterable<Link>) - Method in class org.springframework.hateoas.Links
Returns whether the current Links contain all given Links (but potentially others).
containsSameLinksAs(Iterable<Link>) - Method in class org.springframework.hateoas.Links
Returns whether the current Links instance contains exactly the same Link as the given one.
CONTENTS - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a table of contents.
ControllerEntityLinks - Class in org.springframework.hateoas.server.core
EntityLinks implementation which assumes a certain URI mapping structure: A class-level mapping annotation that can contain template variables.
ControllerEntityLinks(Iterable<? extends Class<?>>, LinkBuilderFactory<? extends LinkBuilder>) - Constructor for class org.springframework.hateoas.server.core.ControllerEntityLinks
Creates a new ControllerEntityLinks inspecting the configured classes for the given annotation.
ControllerEntityLinksFactoryBean - Class in org.springframework.hateoas.server.core
FactoryBean implementation to create ControllerEntityLinks instances looking up controller classes from an ApplicationContext.
ControllerEntityLinksFactoryBean() - Constructor for class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
 
ControllerLinkBuilder - Class in org.springframework.hateoas.server.mvc
Deprecated.
use WebMvcLinkBuilder instead.
ControllerLinkBuilderFactory - Class in org.springframework.hateoas.server.mvc
Deprecated.
ControllerLinkBuilderFactory() - Constructor for class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
 
ControllerLinkRelationProvider - Class in org.springframework.hateoas.server.mvc
 
ControllerLinkRelationProvider(Class<?>, PluginRegistry<LinkRelationProvider, Class<?>>) - Constructor for class org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider
 
CONVERTED_FROM - Static variable in class org.springframework.hateoas.IanaLinkRelations
The document linked to was later converted to the document that contains this link relation.
COPYRIGHT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a copyright statement that applies to the link's context.
create(MethodInvocation, MappingDiscoverer, UriComponents) - Static method in class org.springframework.hateoas.server.core.SpringAffordanceBuilder
Use the attributes of the current method call along with a collection of AffordanceModelFactory's to create a set of Affordances.
CREATE_FORM - Static variable in class org.springframework.hateoas.IanaLinkRelations
The target IRI points to a resource where a submission form can be obtained.
createBuilder(UriComponents, TemplateVariables, List<Affordance>) - Method in interface org.springframework.hateoas.server.core.WebHandler.LinkBuilderCreator
 
createContextual(SerializerProvider, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
createContextual(DeserializationContext, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesDeserializer
 
createContextual(SerializerProvider, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
createContextual(SerializerProvider, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
createInstance() - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
 
createModelWithId(Object, T) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
Creates a new resource with a self link to the given id.
createModelWithId(Object, T, Object...) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
 
createNewInstance(UriComponentsBuilder, List<Affordance>) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
Creates a new instance of the sub-class.
createNewInstance(UriComponentsBuilder, List<Affordance>) - Method in class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
 
createNewInstance(UriComponentsBuilder, List<Affordance>, TemplateVariables) - Method in class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
 
createNewInstance(UriComponentsBuilder, List<Affordance>, TemplateVariables) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
 
createNewInstance(UriComponentsBuilder, List<Affordance>, TemplateVariables) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
 
createNewInstance(UriComponentsBuilder, List<Affordance>, TemplateVariables) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder
 
createObjectFromProperties(Class<T>, Map<String, Object>) - Static method in class org.springframework.hateoas.mediatype.PropertyUtils
 
Curie(String, String) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider.Curie
 
curie(String) - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Creates a new HalLinkRelation curied to the given value.
curieBuilder(String) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Creates a new HalLinkRelation.HalLinkRelationBuilder for the given curie.
curied(String, String) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Creates a new HalLinkRelation for a curied relation.
curieIfUncuried(String) - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Returns a curied HalLinkRelation either using the existing curie or the given one if previously uncuried.
CurieProvider - Interface in org.springframework.hateoas.mediatype.hal
API to provide HAL curie information for links.
CURIES - Static variable in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
CURRENT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource containing the most recent item(s) in a collection of resources.

D

DEFAULT_KEY - Static variable in class org.springframework.hateoas.mediatype.hal.forms.HalFormsTemplate
 
DefaultCurieProvider - Class in org.springframework.hateoas.mediatype.hal
Default implementation of CurieProvider rendering a single configurable UriTemplate based curie.
DefaultCurieProvider(String, UriTemplate) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
Creates a new DefaultCurieProvider for the given name and UriTemplate.
DefaultCurieProvider(Map<String, UriTemplate>) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
Creates a new DefaultCurieProvider for the given curies.
DefaultCurieProvider(Map<String, UriTemplate>, String) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
Creates a new DefaultCurieProvider for the given curies using the one with the given name as default, which means to expand unprefixed, non-IANA link relations.
DefaultCurieProvider.Curie - Class in org.springframework.hateoas.mediatype.hal
Value object to get the curie Link rendered in JSON.
DefaultLinkRelationProvider - Class in org.springframework.hateoas.server.core
Default implementation of LinkRelationProvider to simply use the uncapitalized version of the given type's name as item resource LinkRelation as well as an appended List for the collection resource LinkRelation.
DefaultLinkRelationProvider() - Constructor for class org.springframework.hateoas.server.core.DefaultLinkRelationProvider
 
DelegatingEntityLinks - Class in org.springframework.hateoas.server.core
EntityLinks implementation that delegates to the EntityLinks instances registered in the PluginRegistry given on instance creation.
DelegatingEntityLinks(PluginRegistry<EntityLinks, Class<?>>) - Constructor for class org.springframework.hateoas.server.core.DelegatingEntityLinks
Creates a new DelegatingEntityLinks using the given PluginRegistry.
DelegatingLinkRelationProvider - Class in org.springframework.hateoas.server.core
 
DelegatingLinkRelationProvider() - Constructor for class org.springframework.hateoas.server.core.DelegatingLinkRelationProvider
 
DESCRIBED_BY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource providing information about the link's context.
DESCRIBES - Static variable in class org.springframework.hateoas.IanaLinkRelations
The relationship A 'describes' B asserts that resource A provides a description of resource B.
descriptor() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
Returns a new DescriptorBuilder.
Descriptor - Class in org.springframework.hateoas.mediatype.alps
A value object for an ALPS descriptor.
Descriptor() - Constructor for class org.springframework.hateoas.mediatype.alps.Descriptor
 
deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListDeserializer
 
deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesDeserializer
 
deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.hateoas.server.mvc.JacksonSerializers.MediaTypeDeserializer
 
deserializerInstance(DeserializationConfig, Annotated, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
 
DISCLOSURE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.
DNS_PREFETCH - Static variable in class org.springframework.hateoas.IanaLinkRelations
Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.
doc() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
Returns a new DocBuilder.
Doc - Class in org.springframework.hateoas.mediatype.alps
A value object for an ALPS doc element.
Doc(String, Format) - Constructor for class org.springframework.hateoas.mediatype.alps.Doc
Creates a new Doc instance with the given value and Format.
DummyInvocationUtils - Class in org.springframework.hateoas.server.core
Utility methods to capture dummy method invocations.
DummyInvocationUtils() - Constructor for class org.springframework.hateoas.server.core.DummyInvocationUtils
 
DUPLICATE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.

E

EDIT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that can be used to edit the link's context.
EDIT_FORM - Static variable in class org.springframework.hateoas.IanaLinkRelations
The target IRI points to a resource where a submission form for editing associated resource can be obtained.
EDIT_MEDIA - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that can be used to edit media associated with the link's context.
EmbeddedMapper(LinkRelationProvider, CurieProvider, boolean) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper
Creates a new Jackson2HalModule.EmbeddedMapper for the given LinkRelationProvider, CurieProvider and flag whether to prefer collection relations.
EmbeddedWrapper - Interface in org.springframework.hateoas.server.core
A wrapper to handle values to be embedded into a EntityModel.
EmbeddedWrappers - Class in org.springframework.hateoas.server.core
Interface to mark objects that are aware of the rel they'd like to be exposed under.
EmbeddedWrappers(boolean) - Constructor for class org.springframework.hateoas.server.core.EmbeddedWrappers
Creates a new EmbeddedWrappers.
empty() - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
Creates a new empty HalFormsDocument.
emptyCollectionOf(Class<?>) - Method in class org.springframework.hateoas.server.core.EmbeddedWrappers
Creates an EmbeddedWrapper for an empty Collection with the given element type.
EnableEntityLinks - Annotation Type in org.springframework.hateoas.config
Enables the collection of LinkBuilder instances from the application context.
EnableHypermediaSupport - Annotation Type in org.springframework.hateoas.config
Activates hypermedia support in the ApplicationContext.
EnableHypermediaSupport.HypermediaType - Enum in org.springframework.hateoas.config
Hypermedia representation types supported.
ENCLOSURE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies a related resource that is potentially large and might require special handling.
enhance(UriComponentsBuilder, MethodParameter, Object) - Method in interface org.springframework.hateoas.server.mvc.UriComponentsContributor
Enhance the given UriComponentsBuilder with the given value.
EntityLinks - Interface in org.springframework.hateoas.server
Accessor to links pointing to controllers backing an entity type.
EntityModel<T> - Class in org.springframework.hateoas
A simple EntityModel wrapping a domain object and adding links to it.
EntityModel() - Constructor for class org.springframework.hateoas.EntityModel
Creates an empty EntityModel.
EntityModel(T, Link...) - Constructor for class org.springframework.hateoas.EntityModel
Creates a new EntityModel with the given content and Links (optional).
EntityModel(T, Iterable<Link>) - Constructor for class org.springframework.hateoas.EntityModel
Creates a new EntityModel with the given content and Links.
EntityModelType() - Constructor for class org.springframework.hateoas.server.core.TypeReferences.EntityModelType
 
equals(Object) - Method in class org.springframework.hateoas.CollectionModel
 
equals(Object) - Method in class org.springframework.hateoas.EntityModel
 
equals(Object) - Method in class org.springframework.hateoas.Links
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
 
equals(Object) - Method in class org.springframework.hateoas.PagedModel
 
equals(Object) - Method in class org.springframework.hateoas.PagedModel.PageMetadata
 
equals(Object) - Method in class org.springframework.hateoas.RepresentationModel
 
EvoInflectorLinkRelationProvider - Class in org.springframework.hateoas.server.core
LinkRelationProvider implementation using the Evo Inflector implementation of an algorithmic approach to English plurals.
EvoInflectorLinkRelationProvider() - Constructor for class org.springframework.hateoas.server.core.EvoInflectorLinkRelationProvider
 
expand(Object...) - Method in class org.springframework.hateoas.Link
Turns the current template into a Link by expanding it using the given parameters.
expand(Map<String, ? extends Object>) - Method in class org.springframework.hateoas.Link
Turns the current template into a Link by expanding it using the given parameters.
expand(Object...) - Method in class org.springframework.hateoas.UriTemplate
Expands the UriTemplate using the given parameters.
expand(Map<String, ? extends Object>) - Method in class org.springframework.hateoas.UriTemplate
Expands the UriTemplate using the given parameters.
ExposesResourceFor - Annotation Type in org.springframework.hateoas.server
Annotation to demarcate controllers that expose URI templates of a structure according to ControllerEntityLinks.
ext() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
Returns a new ExtBuilder.
Ext - Class in org.springframework.hateoas.mediatype.alps
A value object for an ALPS ext element.
Ext() - Constructor for class org.springframework.hateoas.mediatype.alps.Ext
 
extractLink(Object, LinkRelation) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
Callback for each LinkDiscoverer to extract relevant attributes and generate a Link.
extractLink(Object, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalLinkDiscoverer
 

F

filter(ServerWebExchange, WebFilterChain) - Method in class org.springframework.hateoas.server.reactive.HypermediaWebFilter
 
findLinksWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
 
findLinksWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
 
findLinksWithRel(String, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Returns all links with the given link relation found in the given String representation.
findLinksWithRel(LinkRelation, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Returns all links with the given LinkRelation found in the given String representation.
findLinksWithRel(String, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Returns all links with the given link relation found in the given InputStream representation.
findLinksWithRel(LinkRelation, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Returns all links with the given LinkRelation found in the given InputStream representation.
findLinksWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
 
findLinksWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
 
findLinksWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
 
findLinksWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
 
findLinkWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
 
findLinkWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
 
findLinkWithRel(LinkRelation, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Finds a single link with the given LinkRelation in the given String representation.
findLinkWithRel(String, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Finds a single link with the given relation type in the given String representation.
findLinkWithRel(LinkRelation, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Finds a single link with the given LinkRelation in the given InputStream representation.
findLinkWithRel(String, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Finds a single link with the given relation type in the given InputStream representation.
findLinkWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
 
findLinkWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
 
findLinkWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
 
findLinkWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
 
findProperties(Object) - Static method in class org.springframework.hateoas.mediatype.PropertyUtils
 
findPropertyNames(ResolvableType) - Static method in class org.springframework.hateoas.mediatype.PropertyUtils
 
findPropertyNames(Class<?>) - Static method in class org.springframework.hateoas.mediatype.PropertyUtils
 
findRequiredLinkWithRel(LinkRelation, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Finds a single link with the given relation in the given String representation.
findRequiredLinkWithRel(LinkRelation, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
Finds a single link with the given relation type in the given InputStream representation.
findRootType(JavaType) - Static method in class org.springframework.hateoas.mediatype.JacksonHelper
Navigate a chain of parametric types (e.g.
FIRST - Static variable in class org.springframework.hateoas.IanaLinkRelations
An IRI that refers to the furthest preceding resource in a series of resources.
follow(String...) - Method in class org.springframework.hateoas.client.Traverson
Sets up a Traverson.TraversalBuilder to follow the given rels.
follow(Hop) - Method in class org.springframework.hateoas.client.Traverson
Sets up a Traverson.TraversalBuilder for a single rel with customized details.
follow(String...) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Follows the given rels one by one, which means a request per rel to discover the next resource with the rel in line.
follow(Hop) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Follows the given rels one by one, which means a request per rel to discover the next resource with the rel in line.
Format - Enum in org.springframework.hateoas.mediatype.alps
Enum for all ALPS doc formats.
forMethod(HttpMethod) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsTemplate
 
forResource(T) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
Creates a new HalFormsDocument for the given resource.
forResources(Collection<T>) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
returns a new HalFormsDocument for the given resources.
forType(Function<T, ? extends Object>) - Method in interface org.springframework.hateoas.server.EntityLinks
Creates a TypedEntityLinks instance using the given identifier extractor function.
forType(Class<T>, Function<T, Object>) - Method in interface org.springframework.hateoas.server.EntityLinks
Creates a TypedEntityLinks instance using the given type and identifier extractor function.
from(String) - Static method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns the TemplateVariable.VariableType for the given variable key.

G

getAffordanceModel(MediaType) - Method in class org.springframework.hateoas.Affordance
Look up the AffordanceModel for the requested MediaType.
getAffordanceModel(String, Link, HttpMethod, ResolvableType, List<QueryParameter>, ResolvableType) - Method in interface org.springframework.hateoas.AffordanceModelFactory
Look up the AffordanceModel for this factory.
getAffordances() - Method in class org.springframework.hateoas.Link
Returns safe copy of Affordances.
getAnnotationType() - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
Returns the annotation type.
getArguments() - Method in interface org.springframework.hateoas.server.core.MethodInvocation
 
getBuilder() - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Returns a UriComponentsBuilder obtained from the current servlet mapping.
getCodes() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.core.DefaultLinkRelationProvider
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingLinkRelationProvider
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.core.EvoInflectorLinkRelationProvider
 
getCollectionResourceRelFor(Class<?>) - Method in interface org.springframework.hateoas.server.LinkRelationProvider
Returns the relation type to be used to point to a collection resource of the given type.
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider
 
getConfiguration() - Method in interface org.springframework.hateoas.config.MediaTypeConfigurationProvider
Returns the primary Spring configuration class to be bootstrapped for the given media type.
getContent() - Method in class org.springframework.hateoas.CollectionModel
Returns the underlying elements.
getContent() - Method in class org.springframework.hateoas.EntityModel
Returns the underlying entity.
getContentDeserializer() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListDeserializer
 
getContentDeserializer() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesDeserializer
 
getContentSerializer() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
getContentSerializer() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
getContentSerializer() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
getContentType() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListDeserializer
 
getContentType() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
getContentType() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesDeserializer
 
getContentType() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
getContentType() - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
getCurieHref(String, UriTemplate) - Method in class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
Returns the href for the DefaultCurieProvider.Curie instance to be created.
getCurieInformation(Links) - Method in interface org.springframework.hateoas.mediatype.hal.CurieProvider
Returns an object to render as the base curie information.
getCurieInformation(Links) - Method in class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
 
getDefaultMessageConverters(MediaType...) - Static method in class org.springframework.hateoas.client.Traverson
Returns all HttpMessageConverters that will be registered for the given MediaTypes by default.
getDefaultTemplate() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
Returns the default template of the document.
getDeprecation() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getHreflang() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getHttpMessageConverters(Collection<MediaType>) - Method in interface org.springframework.hateoas.client.TraversonDefaults
Returns the HttpMessageConverter instances to be registered for the given MediaTypes.
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
 
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.core.DefaultLinkRelationProvider
 
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingLinkRelationProvider
 
getItemResourceRelFor(Class<?>) - Method in interface org.springframework.hateoas.server.LinkRelationProvider
Returns the relation type to be used to point to an item resource of the given type.
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider
 
getJacksonModule() - Method in interface org.springframework.hateoas.config.HypermediaMappingInformation
Optionally return the Jackson Module to be used to customize the serialization of representation models.
getLastInvocation() - Method in interface org.springframework.hateoas.server.core.LastInvocationAware
 
getLink(String) - Method in class org.springframework.hateoas.Links
Returns a Link with the given relation if contained in the current Links instance, Optional.empty() otherwise.
getLink(LinkRelation) - Method in class org.springframework.hateoas.Links
Returns the Link with the given rel.
getLink(String) - Method in class org.springframework.hateoas.RepresentationModel
Returns the link with the given relation.
getLink(LinkRelation) - Method in class org.springframework.hateoas.RepresentationModel
Returns the link with the given LinkRelation.
getLinkDiscovererFor(MediaType) - Method in class org.springframework.hateoas.client.LinkDiscoverers
Returns the LinkDiscoverer suitable for the given MediaType.
getLinkDiscovererFor(String) - Method in class org.springframework.hateoas.client.LinkDiscoverers
Returns the LinkDiscoverer suitable for the given media type.
getLinkDiscoverers(Collection<MediaType>) - Method in interface org.springframework.hateoas.client.TraversonDefaults
Returns the LinkDiscoverers to be registered by default for the given MediaTypes.
getLinks() - Method in class org.springframework.hateoas.mediatype.hal.RepresentationModelMixin
 
getLinks() - Method in class org.springframework.hateoas.RepresentationModel
Returns all Links contained in this resource.
getLinks(String) - Method in class org.springframework.hateoas.RepresentationModel
Returns all Links with the given relation.
getLinks(LinkRelation) - Method in class org.springframework.hateoas.RepresentationModel
Returns all Links with the given relation.
getLogref() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Returns the logref of the error.
getMapping(Class<?>) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
 
getMapping(Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
 
getMapping(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
 
getMapping(Class<?>) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
 
getMapping(Method) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
 
getMapping(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
 
getMapping(Class<?>) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
Returns the mapping associated with the given type.
getMapping(Method) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
Returns the mapping associated with the given Method.
getMapping(Class<?>, Method) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
Returns the mapping for the given Method invoked on the given type.
getMediaType() - Method in interface org.springframework.hateoas.AffordanceModelFactory
Declare the MediaType this factory supports.
getMediaTypes() - Method in enum org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
 
getMediaTypes() - Method in interface org.springframework.hateoas.config.HypermediaMappingInformation
All MediaTypes this hypermedia can handle.
getMediaTypes() - Method in class org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration
 
getMessage() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Returns the message of the error.
getMetadata() - Method in class org.springframework.hateoas.PagedModel
Returns the pagination metadata.
getMethod() - Method in interface org.springframework.hateoas.server.core.MethodInvocation
 
getName() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getNamespacedRelFor(LinkRelation) - Method in interface org.springframework.hateoas.mediatype.hal.CurieProvider
Returns the rel to be rendered for the given rel.
getNamespacedRelFor(LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
 
getNamespacedRelFrom(Link) - Method in interface org.springframework.hateoas.mediatype.hal.CurieProvider
Returns the rel to be rendered for the given Link.
getNamespacedRelFrom(Link) - Method in class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
 
getNextLink() - Method in class org.springframework.hateoas.PagedModel
Returns the Link pointing to the next page (if set).
getNumber() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
Returns the number of the current page.
getObjectParameters() - Method in interface org.springframework.hateoas.server.core.LastInvocationAware
 
getObjectType() - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
 
getOrder() - Method in class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
 
getOrder() - Method in class org.springframework.hateoas.server.core.DefaultLinkRelationProvider
 
getParameter(String) - Method in class org.springframework.hateoas.server.core.MethodParameters
Returns the MethodParameter with the given name or null if none found.
getParameters() - Method in class org.springframework.hateoas.server.core.MethodParameters
Returns all MethodParameters.
getParametersOfType(Class<?>) - Method in class org.springframework.hateoas.server.core.MethodParameters
Returns all parameters of the given type.
getParametersWith(Class<? extends Annotation>) - Method in class org.springframework.hateoas.server.core.MethodParameters
Returns all MethodParameters annotated with the given annotation type.
getPreviousLink() - Method in class org.springframework.hateoas.PagedModel
Returns the Link pointing to the previous page (if set).
getProfile() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getRel() - Method in interface org.springframework.hateoas.server.core.EmbeddedWrapper
Returns the rel to be used when embedding.
getRelTargetType() - Method in interface org.springframework.hateoas.server.core.EmbeddedWrapper
Returns the type to be used to calculate a type based rel.
getRequestMethod(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Extract RequestMapping's list of RequestMethods into an array of Strings.
getRequestMethod(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
 
getRequestMethod(Class<?>, Method) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
Returns the HTTP verbs for the given Method invoked on the given type.
getRequiredLink(String) - Method in class org.springframework.hateoas.Links
Returns the Link with the given relation.
getRequiredLink(LinkRelation) - Method in class org.springframework.hateoas.Links
Returns the Link with the given relation.
getRequiredLink(String) - Method in class org.springframework.hateoas.RepresentationModel
Returns the link with the given relation.
getRequiredLink(LinkRelation) - Method in class org.springframework.hateoas.RepresentationModel
Returns the link with the given relation.
getRequiredLinkDiscovererFor(MediaType) - Method in class org.springframework.hateoas.client.LinkDiscoverers
Returns the LinkDiscoverer suitable for the given MediaType.
getRequiredLinkDiscovererFor(String) - Method in class org.springframework.hateoas.client.LinkDiscoverers
Returns the LinkDiscoverer suitable for the given media type.
getSchema(SerializerProvider, Type) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
getSize() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
Returns the requested size of the page.
getTargetType() - Method in interface org.springframework.hateoas.server.core.MethodInvocation
 
getTemplate(String) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsDocument
Returns the template with the given name.
getThis() - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
Returns the current concrete instance.
getThis() - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
 
getThis() - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
 
getThis() - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder
 
getTitle() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getTotalElements() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
Returns the total number of elements available.
getTotalPages() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
Returns how many pages are available in total.
getType() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getURI() - Method in class org.springframework.hateoas.AffordanceModel
Expand the Link into an href with no parameters.
getValue() - Method in interface org.springframework.hateoas.server.core.EmbeddedWrapper
Returns the actual value to embed.
getValueFrom(MethodParameter) - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
Reads the Annotation attribute's value from the given MethodParameter.
getValueFrom(AnnotatedElement) - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
Reads the Annotation attribute's value from the given AnnotatedElement.
getValueFrom(Annotation) - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
Returns the Annotation attribute's value from the given Annotation.
getVariableNames() - Method in class org.springframework.hateoas.Link
Returns the variable names contained in the template.
getVariableNames() - Method in class org.springframework.hateoas.UriTemplate
Returns the names of the variables discovered.
getVariables() - Method in class org.springframework.hateoas.Link
Returns all TemplateVariables contained in the Link.
getVariables() - Method in class org.springframework.hateoas.UriTemplate
Returns the TemplateVariables discovered.
GLOSSARY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a glossary of terms.

H

HAL_FORMS_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for applicatino/prs.hal-forms+json.
HAL_FORMS_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/prs.hal-forms+json.
HAL_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/hal+json.
HAL_JSON_UTF8 - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/hal+json;charset=UTF-8.
HAL_JSON_UTF8_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.HAL_JSON_UTF8.
HAL_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.HAL_JSON.
HalConfiguration - Class in org.springframework.hateoas.mediatype.hal
HAL specific configuration.
HalConfiguration() - Constructor for class org.springframework.hateoas.mediatype.hal.HalConfiguration
Creates a new default HalConfiguration rendering single links as immediate sub-document.
HalConfiguration.RenderSingleLinks - Enum in org.springframework.hateoas.mediatype.hal
Configuration option how to render single links of a given LinkRelation.
HalFormsDocument<T> - Class in org.springframework.hateoas.mediatype.hal.forms
Representation of a HAL-FORMS document.
HalFormsLinkDiscoverer - Class in org.springframework.hateoas.mediatype.hal.forms
HAL-FORMS based JsonPathLinkDiscoverer.
HalFormsLinkDiscoverer() - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsLinkDiscoverer
 
HalFormsProperty - Class in org.springframework.hateoas.mediatype.hal.forms
Describe a parameter for the associated state transition in a HAL-FORMS document.
HalFormsProperty() - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsProperty
 
HalFormsTemplate - Class in org.springframework.hateoas.mediatype.hal.forms
Value object for a HAL-FORMS template.
HalHandlerInstantiator(LinkRelationProvider, CurieProvider, MessageSourceAccessor) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
 
HalHandlerInstantiator(LinkRelationProvider, CurieProvider, MessageSourceAccessor, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
Creates a new Jackson2HalModule.HalHandlerInstantiator using the given LinkRelationProvider, CurieProvider and MessageSourceAccessor.
HalHandlerInstantiator(LinkRelationProvider, CurieProvider, MessageSourceAccessor, boolean, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
Creates a new Jackson2HalModule.HalHandlerInstantiator using the given LinkRelationProvider, CurieProvider and MessageSourceAccessor and whether to enforce embedded collections.
HalLinkDiscoverer - Class in org.springframework.hateoas.mediatype.hal
LinkDiscoverer implementation based on HAL link structure.
HalLinkDiscoverer() - Constructor for class org.springframework.hateoas.mediatype.hal.HalLinkDiscoverer
Constructor for MediaTypes.HAL_JSON.
HalLinkDiscoverer(MediaType...) - Constructor for class org.springframework.hateoas.mediatype.hal.HalLinkDiscoverer
 
HalLinkListDeserializer() - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListDeserializer
 
HalLinkListSerializer(CurieProvider, Jackson2HalModule.EmbeddedMapper, MessageSourceAccessor, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
HalLinkListSerializer(BeanProperty, CurieProvider, Jackson2HalModule.EmbeddedMapper, MessageSourceAccessor, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
HalLinkRelation - Class in org.springframework.hateoas.mediatype.hal
Value object for HAL based LinkRelation, i.e. a relation that can be curied.
HalLinkRelation() - Constructor for class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
HalLinkRelation.HalLinkRelationBuilder - Interface in org.springframework.hateoas.mediatype.hal
Simple builder interface to easily create multiple HalLinkRelations for a single curie.
HalMediaTypeConfiguration - Class in org.springframework.hateoas.mediatype.hal
Spring configuration to set up HAL support.
HalMediaTypeConfiguration(LinkRelationProvider, ObjectProvider<CurieProvider>, ObjectProvider<HalConfiguration>, MessageSourceAccessor) - Constructor for class org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration
 
HalResourcesDeserializer() - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesDeserializer
 
HalResourcesDeserializer(JavaType) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesDeserializer
 
HalResourcesSerializer(Jackson2HalModule.EmbeddedMapper) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
HalResourcesSerializer(BeanProperty, Jackson2HalModule.EmbeddedMapper) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorHandlerMethodReturnValueHandler
 
hasCuriedEmbed(Iterable<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper
Returns whether the given source elements will be namespaced.
hasDescription() - Method in class org.springframework.hateoas.TemplateVariable
Returns whether the variable has a description.
hashCode() - Method in class org.springframework.hateoas.CollectionModel
 
hashCode() - Method in class org.springframework.hateoas.EntityModel
 
hashCode() - Method in class org.springframework.hateoas.Links
 
hashCode() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
 
hashCode() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
 
hashCode() - Method in class org.springframework.hateoas.PagedModel
 
hashCode() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
 
hashCode() - Method in class org.springframework.hateoas.RepresentationModel
 
hasHttpMethod(HttpMethod) - Method in class org.springframework.hateoas.AffordanceModel
Returns whether the Affordance has the given HttpMethod.
hasLink(String) - Method in class org.springframework.hateoas.Links
Returns whether the Links container contains a Link with the given relation.
hasLink(LinkRelation) - Method in class org.springframework.hateoas.Links
Returns whether the current Links contains a Link with the given relation.
hasLink(String) - Method in class org.springframework.hateoas.RepresentationModel
Returns whether the resource contains a Link with the given rel.
hasLink(LinkRelation) - Method in class org.springframework.hateoas.RepresentationModel
 
hasLinks() - Method in class org.springframework.hateoas.RepresentationModel
Returns whether the resource contains Links at all.
hasRel(String) - Method in class org.springframework.hateoas.Link
Returns whether the current Link has the given link relation.
hasRel(LinkRelation) - Method in class org.springframework.hateoas.Link
Returns whether the Link has the given LinkRelation.
hasRel(LinkRelation) - Method in interface org.springframework.hateoas.server.core.EmbeddedWrapper
Returns whether the wrapper has the given rel.
hasSingleElement(Links) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
hasSingleElement(Collection<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
hasSingleElement(Object) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
hasSingleLink() - Method in class org.springframework.hateoas.Links
Returns whether the Links contain a single Link.
hasSize(long) - Method in class org.springframework.hateoas.Links
Returns whether the current Links has the given size.
header(String, String) - Method in class org.springframework.hateoas.client.Hop
Add one header to the HttpHeaders collection.
HeaderLinksResponseEntity<T extends RepresentationModel<?>> - Class in org.springframework.hateoas.server.core
Special ResponseEntity that exposes Link instances in the contained RepresentationModel as link headers instead of in the body.
HELP - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to context-sensitive help.
Hop - Class in org.springframework.hateoas.client
Container for customizations to a single traverson "hop"
Hop() - Constructor for class org.springframework.hateoas.client.Hop
 
HOSTS - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource hosted by the server indicated by the link context.
HUB - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a hub that enables registration for notification of updates to the context.
hypermediaExchangeStrategies() - Method in class org.springframework.hateoas.config.WebClientConfigurer
Return a set of ExchangeStrategies driven by registered EnableHypermediaSupport.HypermediaTypes.
HypermediaMappingInformation - Interface in org.springframework.hateoas.config
Interface for registering custom hypermedia handlers.
HypermediaWebFilter - Class in org.springframework.hateoas.server.reactive
WebFilter that ensures a copy of the ServerWebExchange is added to the Reactor Context.
HypermediaWebFilter() - Constructor for class org.springframework.hateoas.server.reactive.HypermediaWebFilter
 

I

IanaLinkRelations - Class in org.springframework.hateoas
Capture standard IANA-based link relations.
IanaLinkRelations() - Constructor for class org.springframework.hateoas.IanaLinkRelations
 
IanaRels - Class in org.springframework.hateoas
Deprecated.
IanaRels() - Constructor for class org.springframework.hateoas.IanaRels
Deprecated.
 
ICON - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to an icon representing the link's context.
INDEX - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to an index.
instantiateModel(T) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
Instantiates the resource object.
INTERVAL_AFTER - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that ends before the beginning of the time interval associated with the context resource
INTERVAL_BEFORE - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource
INTERVAL_CONTAINS - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource
INTERVAL_DISJOINT - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource, or ends before the beginning of the time interval associated with the context resource
INTERVAL_DURING - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
INTERVAL_EQUALS - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
INTERVAL_FINISHED_BY - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
INTERVAL_FINISHES - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
INTERVAL_IN - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins before or is coincident with the beginning of the time interval associated with the context resource, and ends after or is coincident with the end of the time interval associated with the context resource
INTERVAL_MEETS - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resource
INTERVAL_MET_BY - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resource
INTERVAL_OVERLAPPED_BY - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the beginning of the time interval associated with the context resource
INTERVAL_OVERLAPS - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval that begins before the end of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
INTERVAL_STARTED_BY - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource
INTERVAL_STARTS - Static variable in class org.springframework.hateoas.IanaLinkRelations
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
invokeProcessorsFor(T) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker
Invokes all RepresentationModelProcessor instances registered for the type of the given value.
invokeProcessorsFor(T, ResolvableType) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker
Invokes all RepresentationModelProcessor instances registered for the type of the given value and reference type.
isAlreadyRegisteredIn(ObjectMapper) - Static method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule
Returns whether the module was already registered in the given ObjectMapper.
isAvailable() - Method in enum org.springframework.hateoas.support.WebStack
Is this web stack on the classpath?
isCollectionValue() - Method in interface org.springframework.hateoas.server.core.EmbeddedWrapper
Returns whether the wrapper is a collection value.
isCuried() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Returns whether the link relation is curied.
isEmpty() - Method in class org.springframework.hateoas.Links
Returns whether the Links container is empty.
isEmpty(SerializerProvider, Links) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
isEmpty(SerializerProvider, Collection<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
isEmpty(SerializerProvider, Object) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
isEmpty(SerializerProvider, Boolean) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
isIanaRel(String) - Static method in class org.springframework.hateoas.IanaLinkRelations
Is this relation an IANA standard?
isIanaRel(LinkRelation) - Static method in class org.springframework.hateoas.IanaLinkRelations
Is this relation an IANA standard?
isIanaRel(String) - Static method in class org.springframework.hateoas.IanaRels
Deprecated.
isOptional() - Method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns whether the variable of this type is optional.
isResourcesOfResource(JavaType) - Static method in class org.springframework.hateoas.mediatype.JacksonHelper
Is this a {@literal Resources
isSameAs(LinkRelation) - Method in interface org.springframework.hateoas.LinkRelation
Returns whether the given LinkRelation is logically the same as the current one, independent of implementation, i.e. whether the plain String values match.
isTemplate(String) - Static method in class org.springframework.hateoas.UriTemplate
Returns whether the given candidate is a URI template.
isTemplated() - Method in class org.springframework.hateoas.Link
Returns whether or not the link is templated.
isTemplated() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
ITEM - Static variable in class org.springframework.hateoas.IanaLinkRelations
The target IRI points to a resource that is a member of the collection represented by the context IRI.
iterator() - Method in class org.springframework.hateoas.CollectionModel
 
iterator() - Method in class org.springframework.hateoas.Links
 
iterator() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
 
iterator() - Method in class org.springframework.hateoas.TemplateVariables
 
iterator() - Method in class org.springframework.hateoas.UriTemplate
 

J

Jackson2HalModule - Class in org.springframework.hateoas.mediatype.hal
Jackson 2 module implementation to render Link and RepresentationModel instances in HAL compatible JSON.
Jackson2HalModule() - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule
 
Jackson2HalModule.EmbeddedMapper - Class in org.springframework.hateoas.mediatype.hal
Helper to easily map embedded resources and find out whether they were curied.
Jackson2HalModule.HalHandlerInstantiator - Class in org.springframework.hateoas.mediatype.hal
HandlerInstantiator to create HAL-specific serializers, deserializers etc.
Jackson2HalModule.HalLinkListDeserializer - Class in org.springframework.hateoas.mediatype.hal
 
Jackson2HalModule.HalLinkListSerializer - Class in org.springframework.hateoas.mediatype.hal
Custom JsonSerializer to render Link instances in HAL compatible JSON.
Jackson2HalModule.HalResourcesDeserializer - Class in org.springframework.hateoas.mediatype.hal
 
Jackson2HalModule.HalResourcesSerializer - Class in org.springframework.hateoas.mediatype.hal
Custom JsonSerializer to render EntityModel-Lists in HAL compatible JSON.
Jackson2HalModule.OptionalListJackson2Serializer - Class in org.springframework.hateoas.mediatype.hal
Custom JsonSerializer to render Link instances in HAL compatible JSON.
Jackson2HalModule.TrueOnlyBooleanSerializer - Class in org.springframework.hateoas.mediatype.hal
JsonSerializer to only render Boolean values if they're set to true.
Jackson2UberModule - Class in org.springframework.hateoas.mediatype.uber
Jackson SimpleModule for UBER+JSON serializers and deserializers.
Jackson2UberModule() - Constructor for class org.springframework.hateoas.mediatype.uber.Jackson2UberModule
 
JacksonHelper - Class in org.springframework.hateoas.mediatype
Jackson utility methods.
JacksonHelper() - Constructor for class org.springframework.hateoas.mediatype.JacksonHelper
 
JacksonSerializers - Class in org.springframework.hateoas.server.mvc
Simple Jackson serializers and deserializers.
JacksonSerializers() - Constructor for class org.springframework.hateoas.server.mvc.JacksonSerializers
 
JacksonSerializers.MediaTypeDeserializer - Class in org.springframework.hateoas.server.mvc
Custom JsonDeserializer for Spring's MediaType using the MediaType.parseMediaType(String) method.
JsonPathLinkDiscoverer - Class in org.springframework.hateoas.client
LinkDiscoverer that uses JsonPath to find links inside a representation.
JsonPathLinkDiscoverer(String, MediaType...) - Constructor for class org.springframework.hateoas.client.JsonPathLinkDiscoverer
Creates a new JsonPathLinkDiscoverer using the given path template supporting the given MediaType.

K

keyDeserializerInstance(DeserializationConfig, Annotated, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
 

L

LAST - Static variable in class org.springframework.hateoas.IanaLinkRelations
An IRI that refers to the furthest following resource in a series of resources.
LastInvocationAware - Interface in org.springframework.hateoas.server.core
 
LATEST_VERSION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a resource containing the latest (e.g., current) version of the context.
LICENSE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a license associated with this context.
Link - Class in org.springframework.hateoas
Value object for links.
Link(String) - Constructor for class org.springframework.hateoas.Link
Creates a new link to the given URI with the self rel.
Link(String, String) - Constructor for class org.springframework.hateoas.Link
Creates a new Link to the given URI with the given rel.
Link(String, LinkRelation) - Constructor for class org.springframework.hateoas.Link
Creates a new Link to the given URI with the given rel.
Link(UriTemplate, String) - Constructor for class org.springframework.hateoas.Link
Creates a new Link from the given UriTemplate and rel.
Link(UriTemplate, LinkRelation) - Constructor for class org.springframework.hateoas.Link
Creates a new Link from the given UriTemplate and rel.
Link() - Constructor for class org.springframework.hateoas.Link
Empty constructor required by the marshaling framework.
LinkBuilder - Interface in org.springframework.hateoas.server
Builder to ease building Link instances.
LinkBuilderFactory<T extends LinkBuilder> - Interface in org.springframework.hateoas.server
Factory for LinkBuilder instances.
LinkBuilderSupport<T extends LinkBuilder> - Class in org.springframework.hateoas.server.core
Base class to implement LinkBuilders based on a Spring MVC UriComponentsBuilder.
LinkBuilderSupport(UriComponentsBuilder) - Constructor for class org.springframework.hateoas.server.core.LinkBuilderSupport
Creates a new LinkBuilderSupport using the given UriComponents.
LinkBuilderSupport(UriComponentsBuilder, List<Affordance>) - Constructor for class org.springframework.hateoas.server.core.LinkBuilderSupport
 
LinkBuilderSupport(UriComponents, List<Affordance>) - Constructor for class org.springframework.hateoas.server.core.LinkBuilderSupport
 
LinkDiscoverer - Interface in org.springframework.hateoas.client
Interface to allow discovering links by relation type from some source.
LinkDiscoverers - Class in org.springframework.hateoas.client
Value object to wrap a PluginRegistry for LinkDiscoverer so that it's easier to inject them into clients wanting to lookup a LinkDiscoverer for a given MediaTypes.
LinkDiscoverers(PluginRegistry<LinkDiscoverer, MediaType>) - Constructor for class org.springframework.hateoas.client.LinkDiscoverers
Creates a new LinkDiscoverers instance with the given PluginRegistry.
linkFor(Class<?>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
 
linkFor(Class<?>, Object...) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
 
linkFor(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
 
linkFor(Class<?>, Object...) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
 
linkFor(Class<?>) - Method in interface org.springframework.hateoas.server.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity type.
linkFor(Class<?>, Object...) - Method in interface org.springframework.hateoas.server.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity type, unfolding the given parameters into the URI template the backing controller is mapped to.
linkForItemResource(Class<?>, Object) - Method in class org.springframework.hateoas.server.core.AbstractEntityLinks
 
linkForItemResource(Class<?>, Object) - Method in interface org.springframework.hateoas.server.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity type and id.
linkForItemResource(T, Function<T, Object>) - Method in interface org.springframework.hateoas.server.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity type and identifier extractor.
linkForItemResource(T) - Method in class org.springframework.hateoas.server.TypedEntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity.
LinkMixin - Class in org.springframework.hateoas.mediatype.hal
Custom mixin to avoid rel attributes being rendered for HAL.
LinkMixin() - Constructor for class org.springframework.hateoas.mediatype.hal.LinkMixin
 
LinkRelation - Interface in org.springframework.hateoas
Interface for defining link relations.
LinkRelationProvider - Interface in org.springframework.hateoas.server
API to provide LinkRelations for collections and items of the given type.
Links - Class in org.springframework.hateoas
Value object to represent a list of Links.
Links.MergeMode - Enum in org.springframework.hateoas
The mode how to merge two Links instances.
linkTo(Object, WebHandler.LinkBuilderCreator<T>) - Static method in class org.springframework.hateoas.server.core.WebHandler
 
linkTo(Object, WebHandler.LinkBuilderCreator<T>, BiFunction<UriComponentsBuilder, MethodInvocation, UriComponentsBuilder>) - Static method in class org.springframework.hateoas.server.core.WebHandler
 
linkTo(Class<?>) - Method in interface org.springframework.hateoas.server.LinkBuilderFactory
Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
linkTo(Class<?>, Object...) - Method in interface org.springframework.hateoas.server.LinkBuilderFactory
Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
linkTo(Class<?>, Map<String, ?>) - Method in interface org.springframework.hateoas.server.LinkBuilderFactory
Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
linkTo(Method, Object...) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
Returns a LinkBuilder pointing to the URI mapped to the given Method and expanding this mapping using the given parameters.
linkTo(Class<?>, Method, Object...) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
Returns a LinkBuilder pointing to the URI mapped to the given Method assuming it was invoked on an object of the given type.
linkTo(Object) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
Returns a LinkBuilder pointing to the URI mapped to the method the result is handed into this method.
linkTo(Class<?>) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Class<?>, Object...) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Class<?>, Map<String, ?>) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Method, Object...) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
 
linkTo(Class<?>, Method, Object...) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
 
linkTo(Object) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Creates a ControllerLinkBuilder pointing to a controller method.
linkTo(Class<?>) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
 
linkTo(Class<?>, Object...) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
 
linkTo(Class<?>, Map<String, ?>) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
 
linkTo(Class<?>, Method, Object...) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
 
linkTo(Object) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
 
linkTo(Method, Object...) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
 
linkTo(Class<?>) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
Creates a new WebMvcLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Class<?>, Object...) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
Creates a new WebMvcLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Class<?>, Map<String, ?>) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
Creates a new WebMvcLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Method, Object...) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
 
linkTo(Class<?>, Method, Object...) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
 
linkTo(Object) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
Creates a WebMvcLinkBuilder pointing to a controller method.
linkTo(Class<?>) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
 
linkTo(Class<?>, Object...) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
 
linkTo(Class<?>, Map<String, ?>) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
 
linkTo(Class<?>, Method, Object...) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
 
linkTo(Object) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
 
linkTo(Method, Object...) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
 
linkTo(Object) - Static method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder
Create a WebFluxLinkBuilder by checking if the Reactor Context contains a ServerWebExchange and using that combined with the Spring Web annotations to build a full URI.
linkTo(Object, ServerWebExchange) - Static method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder
Create a WebFluxLinkBuilder using an explicitly defined ServerWebExchange.
linkToCollectionResource(Class<?>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
 
linkToCollectionResource(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
 
linkToCollectionResource(Class<?>) - Method in interface org.springframework.hateoas.server.EntityLinks
Creates a Link pointing to the collection resource of the given type.
linkToCollectionResource() - Method in class org.springframework.hateoas.server.TypedEntityLinks.ExtendedTypedEntityLinks
Creates a Link pointing to the collection resource of the configured type.
linkToItemResource(Class<?>, Object) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
 
linkToItemResource(Class<?>, Object) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
 
linkToItemResource(Class<?>, Object) - Method in interface org.springframework.hateoas.server.EntityLinks
Creates a Link pointing to item resource backing the given entity type and id.
linkToItemResource(T, Function<T, Object>) - Method in interface org.springframework.hateoas.server.EntityLinks
Creates a Link pointing to item resource backing the given entity and identifier extractor.
linkToItemResource(T) - Method in class org.springframework.hateoas.server.TypedEntityLinks
Creates a Link pointing to item resource backing the given entity.
LRDD - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to further information about the link's context, expressed as a LRDD ("Link-based Resource Descriptor Document") resource.

M

manyOf(String...) - Static method in interface org.springframework.hateoas.LinkRelation
Creates a new Iterable of LinkRelation for each of the given Strings.
map(Iterable<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper
Maps the given source elements as embedded values.
map(Iterable<? extends T>) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
 
map(Function<Link, Link>) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
Creates a new WebFluxLinkBuilder.WebFluxLink with the current Link instance transformed using the given mapper.
MappingDiscoverer - Interface in org.springframework.hateoas.server.core
Strategy interface to discover a URI mapping and related Affordances for either a given type or method.
MediaTypeConfigurationProvider - Interface in org.springframework.hateoas.config
SPI to register a media type configuration provider.
MediaTypeDeserializer() - Constructor for class org.springframework.hateoas.server.mvc.JacksonSerializers.MediaTypeDeserializer
 
MediaTypes - Class in org.springframework.hateoas
Constants for well-known hypermedia types.
MediaTypes() - Constructor for class org.springframework.hateoas.MediaTypes
 
MEMENTO - Static variable in class org.springframework.hateoas.IanaLinkRelations
The Target IRI points to a Memento, a fixed resource that will not change state anymore.
merge(Link...) - Method in class org.springframework.hateoas.Links
Merges the current Links with the given ones, skipping Links already contained in the current instance.
merge(Iterable<Link>) - Method in class org.springframework.hateoas.Links
Merges the current Links with the given ones, skipping Links already contained in the current instance.
merge(Links.MergeMode, Link...) - Method in class org.springframework.hateoas.Links
Merges the current Links with the given ones applying the given Links.MergeMode.
merge(Links.MergeMode, Iterable<Link>) - Method in class org.springframework.hateoas.Links
Merges the current Links with the given ones applying the given Links.MergeMode.
MethodInvocation - Interface in org.springframework.hateoas.server.core
 
MethodLinkBuilderFactory<T extends LinkBuilder> - Interface in org.springframework.hateoas.server
Extension of LinkBuilderFactory for implementations that also support creating LinkBuilders by pointing to a method.
methodOn(Class<T>, Object...) - Static method in class org.springframework.hateoas.server.core.DummyInvocationUtils
Returns a proxy of the given type, backed by an EmptyTargetSource to simply drop method invocations but equips it with an InvocationRecordingMethodInterceptor.
methodOn(Class<T>, Object...) - Static method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of ControllerLinkBuilder.
methodOn(Class<T>, Object...) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of WebMvcLinkBuilder.
methodOn(Class<T>, Object...) - Static method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder
Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of WebFluxLinkBuilder.
MethodParameters - Class in org.springframework.hateoas.server.core
Value object to represent MethodParameters to allow to easily find the ones with a given annotation.
MethodParameters(Method) - Constructor for class org.springframework.hateoas.server.core.MethodParameters
Creates a new MethodParameters from the given Method.
MethodParameters(Method, AnnotationAttribute) - Constructor for class org.springframework.hateoas.server.core.MethodParameters
Creates a new MethodParameters for the given Method and AnnotationAttribute.
MONITOR - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that can be used to monitor changes in an HTTP resource.
MONITOR_GROUP - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.

N

named(String) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsProperty
Creates a new HalFormsProperty with the given name.
NEXT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates that the link's context is a part of a series, and that the next in the series is the link target.
NEXT_ARCHIVE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the immediately following archive resource.
NO_PAGE - Static variable in class org.springframework.hateoas.PagedModel
 
NO_RELATION - Static variable in annotation type org.springframework.hateoas.server.core.Relation
 
NOFOLLOW - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates that the context’s original author or publisher does not endorse the link target.
NONE - Static variable in class org.springframework.hateoas.Links
 
NONE - Static variable in class org.springframework.hateoas.TemplateVariables
 
NOREFERRER - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates that no referrer information is to be leaked when following the link.

O

of(String) - Static method in interface org.springframework.hateoas.LinkRelation
Creates a new LinkRelation.
of(Link...) - Static method in class org.springframework.hateoas.Links
Creates a new Links instance from the given Links.
of(Iterable<Link>) - Static method in class org.springframework.hateoas.Links
Creates a new Links instance from the given Links.
of(LinkRelation) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Returns a HalLinkRelation for the given general LinkRelation.
OptionalListJackson2Serializer(BeanProperty, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
Creates a new Jackson2HalModule.OptionalListJackson2Serializer using the given BeanProperty.
org.springframework.hateoas - package org.springframework.hateoas
Value objects to ease creating Links and link driven representations for REST webservices.
org.springframework.hateoas.client - package org.springframework.hateoas.client
Client side support.
org.springframework.hateoas.config - package org.springframework.hateoas.config
Spring container configuration support.
org.springframework.hateoas.mediatype - package org.springframework.hateoas.mediatype
 
org.springframework.hateoas.mediatype.alps - package org.springframework.hateoas.mediatype.alps
Value objects to build ALPS metadata.
org.springframework.hateoas.mediatype.collectionjson - package org.springframework.hateoas.mediatype.collectionjson
 
org.springframework.hateoas.mediatype.hal - package org.springframework.hateoas.mediatype.hal
HAL-specific extensions, SPIs and Jackson customizations.
org.springframework.hateoas.mediatype.hal.forms - package org.springframework.hateoas.mediatype.hal.forms
 
org.springframework.hateoas.mediatype.uber - package org.springframework.hateoas.mediatype.uber
 
org.springframework.hateoas.mediatype.vnderrors - package org.springframework.hateoas.mediatype.vnderrors
 
org.springframework.hateoas.server - package org.springframework.hateoas.server
 
org.springframework.hateoas.server.core - package org.springframework.hateoas.server.core
Implementations of core API interfaces.
org.springframework.hateoas.server.mvc - package org.springframework.hateoas.server.mvc
Spring MVC helper classes to build Links and assemble RepresentationModel types.
org.springframework.hateoas.server.reactive - package org.springframework.hateoas.server.reactive
 
org.springframework.hateoas.support - package org.springframework.hateoas.support
 
ORIGINAL - Static variable in class org.springframework.hateoas.IanaLinkRelations
The Target IRI points to an Original Resource.

P

PagedModel<T> - Class in org.springframework.hateoas
DTO to implement binding response representations of pageable collections.
PagedModel() - Constructor for class org.springframework.hateoas.PagedModel
Default constructor to allow instantiation by reflection.
PagedModel(Collection<T>, PagedModel.PageMetadata, Link...) - Constructor for class org.springframework.hateoas.PagedModel
Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).
PagedModel(Collection<T>, PagedModel.PageMetadata, Iterable<Link>) - Constructor for class org.springframework.hateoas.PagedModel
Creates a new PagedModel from the given content PagedModel.PageMetadata and Links.
PagedModel.PageMetadata - Class in org.springframework.hateoas
Value object for pagination metadata.
PagedModelType() - Constructor for class org.springframework.hateoas.server.core.TypeReferences.PagedModelType
 
PageMetadata() - Constructor for class org.springframework.hateoas.PagedModel.PageMetadata
 
PageMetadata(long, long, long, long) - Constructor for class org.springframework.hateoas.PagedModel.PageMetadata
Creates a new PagedModel.PageMetadata from the given size, number, total elements and total pages.
PageMetadata(long, long, long) - Constructor for class org.springframework.hateoas.PagedModel.PageMetadata
Creates a new PagedModel.PageMetadata from the given size, number and total elements.
parse(String) - Static method in class org.springframework.hateoas.IanaLinkRelations
Convert a string-based link relation to a IanaLinkRelations.
parse(String) - Static method in class org.springframework.hateoas.Links
Creates a Links instance from the given RFC5988-compatible link format.
PAYMENT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates a resource where payment is accepted.
PINGBACK - Static variable in class org.springframework.hateoas.IanaLinkRelations
Gives the address of the pingback resource for the link context.
pointsToTargetOf(Link) - Method in class org.springframework.hateoas.AffordanceModel
Returns whether the Affordance points to the target of the given Link.
PRECONNECT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Used to indicate an origin that will be used to fetch required resources for the link context.
PREDECESSOR_VERSION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a resource containing the predecessor version in the version history.
PREFETCH - Static variable in class org.springframework.hateoas.IanaLinkRelations
The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.
PRELOAD - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.
PRERENDER - Static variable in class org.springframework.hateoas.IanaLinkRelations
Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.
PREV - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates that the link's context is a part of a series, and that the previous in the series is the link target.
PREV_ARCHIVE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the immediately preceding archive resource.
PREVIEW - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that provides a preview of the link's context.
PREVIOUS - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the previous resource in an ordered series of resources.
PRIVACY_POLICY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a privacy policy associated with the link's context.
process(T) - Method in interface org.springframework.hateoas.server.RepresentationModelProcessor
Processes the given representation model, add links, alter the domain data etc.
PROFILE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.
PropertyUtils - Class in org.springframework.hateoas.mediatype
 
PropertyUtils() - Constructor for class org.springframework.hateoas.mediatype.PropertyUtils
 

Q

QueryParameter - Class in org.springframework.hateoas
Representation of a web request's query parameter (http://example.com?
QueryParameter() - Constructor for class org.springframework.hateoas.QueryParameter
 

R

ReactiveRepresentationModelAssembler<T,D extends RepresentationModel<D>> - Interface in org.springframework.hateoas.server.reactive
registerHypermediaTypes(WebClient) - Method in class org.springframework.hateoas.config.WebClientConfigurer
Register the proper ExchangeStrategies for a given WebClient.
rel(String) - Static method in class org.springframework.hateoas.client.Hop
Creates a new Hop for the given relation name.
REL_FIRST - Static variable in class org.springframework.hateoas.Link
Deprecated.
REL_LAST - Static variable in class org.springframework.hateoas.Link
Deprecated.
REL_NEXT - Static variable in class org.springframework.hateoas.Link
Deprecated.
REL_PREVIOUS - Static variable in class org.springframework.hateoas.Link
Deprecated.
REL_SELF - Static variable in class org.springframework.hateoas.Link
Deprecated.
RELATED - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies a related resource.
relation(String) - Method in interface org.springframework.hateoas.mediatype.hal.HalLinkRelation.HalLinkRelationBuilder
Creates a new HalLinkRelation based on the current curie settings.
Relation - Annotation Type in org.springframework.hateoas.server.core
Annotation to configure the relation to be used when embedding objects in HAL representations of EntityModels and CollectionModel.
removeLinks() - Method in class org.springframework.hateoas.RepresentationModel
Removes all Links added to the resource so far.
REPLIES - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies a resource that is a reply to the context of the link.
RepresentationModel<T extends RepresentationModel<? extends T>> - Class in org.springframework.hateoas
Base class for DTOs to collect links.
RepresentationModel() - Constructor for class org.springframework.hateoas.RepresentationModel
 
RepresentationModel(Link) - Constructor for class org.springframework.hateoas.RepresentationModel
 
RepresentationModel(List<Link>) - Constructor for class org.springframework.hateoas.RepresentationModel
 
RepresentationModelAssembler<T,D extends RepresentationModel<?>> - Interface in org.springframework.hateoas.server
Interface for components that convert a domain type into a RepresentationModel.
RepresentationModelAssemblerSupport<T,D extends RepresentationModel<D>> - Class in org.springframework.hateoas.server.mvc
Base class to implement RepresentationModelAssemblers.
RepresentationModelAssemblerSupport(Class<?>, Class<D>) - Constructor for class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
Creates a new RepresentationModelAssemblerSupport using the given controller class and resource type.
RepresentationModelMixin - Class in org.springframework.hateoas.mediatype.hal
Custom mixin to render Links in HAL.
RepresentationModelMixin() - Constructor for class org.springframework.hateoas.mediatype.hal.RepresentationModelMixin
 
RepresentationModelProcessor<T extends RepresentationModel<?>> - Interface in org.springframework.hateoas.server
SPI interface to allow components to process the RepresentationModel instances returned from Spring MVC controllers.
RepresentationModelProcessorHandlerMethodReturnValueHandler - Class in org.springframework.hateoas.server.mvc
HandlerMethodReturnValueHandler to post-process the objects returned from controller methods using the configured RepresentationModelProcessors.
RepresentationModelProcessorHandlerMethodReturnValueHandler() - Constructor for class org.springframework.hateoas.server.mvc.RepresentationModelProcessorHandlerMethodReturnValueHandler
 
RepresentationModelProcessorInvoker - Class in org.springframework.hateoas.server.mvc
Component to easily invoke all RepresentationModelProcessor instances registered for values of type RepresentationModel.
RepresentationModelProcessorInvoker(Collection<RepresentationModelProcessor<?>>) - Constructor for class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker
Creates a new RepresentationModelProcessorInvoker to consider the given RepresentationModelProcessor to post-process the controller methods return value to before invoking the delegate.
RepresentationModelProcessorInvoker.ResourcesProcessorWrapper - Class in org.springframework.hateoas.server.mvc
ProcessorWrapper for RepresentationModelProcessors targeting CollectionModel.
RepresentationModelProcessorInvokingHandlerAdapter - Class in org.springframework.hateoas.server.mvc
Special RequestMappingHandlerAdapter that tweaks the HandlerMethodReturnValueHandlerComposite to be proxied by a RepresentationModelProcessorHandlerMethodReturnValueHandler which will invoke the RepresentationModelProcessor s found in the application context and eventually delegate to the originally configured HandlerMethodReturnValueHandler.
RepresentationModelProcessorInvokingHandlerAdapter() - Constructor for class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvokingHandlerAdapter
 
ResourcesProcessorWrapper(RepresentationModelProcessor<?>) - Constructor for class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.ResourcesProcessorWrapper
RESTCONF - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies the root of RESTCONF API as configured on this HTTP server.

S

SEARCH - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that can be used to search through the link's context and related resources.
SECTION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a section in a collection of resources.
SELF - Static variable in class org.springframework.hateoas.IanaLinkRelations
Conveys an identifier for the link's context.
serialize(Links, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
serialize(Collection<?>, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
serialize(Object, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
serialize(Boolean, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
serializerInstance(SerializationConfig, Annotated, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
 
SERVER_WEB_EXCHANGE - Static variable in class org.springframework.hateoas.server.reactive.HypermediaWebFilter
 
SERVICE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates a URI that can be used to retrieve a service document.
setAnnotation(Class<? extends Annotation>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
Configures the annotation type to inspect the ApplicationContext for beans that carry the given annotation.
setApplicationContext(ApplicationContext) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
 
setLinkBuilderFactory(LinkBuilderFactory<? extends LinkBuilder>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
Configures the LinkBuilderFactory to be used to create LinkBuilder instances.
setLinkDiscoverers(List<? extends LinkDiscoverer>) - Method in class org.springframework.hateoas.client.Traverson
Sets the LinkDiscoverers to use.
setRestOperations(RestOperations) - Method in class org.springframework.hateoas.client.Traverson
Configures the RestOperations to use.
setRootLinksAsHeaders(boolean) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorHandlerMethodReturnValueHandler
 
setUriComponentsContributors(List<? extends UriComponentsContributor>) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilderFactory
Deprecated.
Configures the UriComponentsContributor to be used when building Link instances from method invocations.
setUriComponentsContributors(List<? extends UriComponentsContributor>) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
Configures the UriComponentsContributor to be used when building Link instances from method invocations.
SimpleReactiveRepresentationModelAssembler<T> - Interface in org.springframework.hateoas.server.reactive
SimpleRepresentationModelAssembler<T> - Interface in org.springframework.hateoas.server
A RepresentationModelAssembler based purely on the domain type, using EntityRepresentationModel<T> as the enclosing representation model type.
slash(Object) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
slash(UriComponents, boolean) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
slash(Object) - Method in interface org.springframework.hateoas.server.LinkBuilder
Adds the given object's String representation as sub-resource to the current URI.
SpringAffordanceBuilder - Class in org.springframework.hateoas.server.core
Extract information needed to assemble an Affordance from a Spring MVC web method.
SpringAffordanceBuilder() - Constructor for class org.springframework.hateoas.server.core.SpringAffordanceBuilder
 
START - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the first resource in a collection of resources.
stream() - Method in class org.springframework.hateoas.Links
Creates a Stream of the current Links.
STYLESHEET - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a stylesheet.
SUBSECTION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource serving as a subsection in a collection of resources.
SUCCESSOR_VERSION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a resource containing the successor version in the version history.
supports(MediaType) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
 
supports(MediaType) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.core.DefaultLinkRelationProvider
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingLinkRelationProvider
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider
 
supports(ResolvableType, Object) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.ResourcesProcessorWrapper
 
supportsAny(Collection<MediaType>) - Method in interface org.springframework.hateoas.config.MediaTypeConfigurationProvider
Returns whether the provider supports any of the given MediaTypes.
supportsParameter(MethodParameter) - Method in interface org.springframework.hateoas.server.mvc.UriComponentsContributor
Returns whether the UriComponentsBuilder supports the given MethodParameter.
supportsReturnType(MethodParameter) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorHandlerMethodReturnValueHandler
 

T

TAG - Static variable in class org.springframework.hateoas.IanaLinkRelations
Gives a tag (identified by the given address) that applies to the current document.
templateFor(String) - Static method in class org.springframework.hateoas.server.core.UriTemplateFactory
Returns the the UriTemplate for the given mapping.
TemplateVariable - Class in org.springframework.hateoas
A single template variable.
TemplateVariable(String, TemplateVariable.VariableType) - Constructor for class org.springframework.hateoas.TemplateVariable
Creates a new TemplateVariable with the given name and type.
TemplateVariable(String, TemplateVariable.VariableType, String) - Constructor for class org.springframework.hateoas.TemplateVariable
Creates a new TemplateVariable with the given name, type and description.
TemplateVariable.VariableType - Enum in org.springframework.hateoas
An enumeration for all supported variable types.
TemplateVariableAwareLinkBuilderSupport<T extends TemplateVariableAwareLinkBuilderSupport<T>> - Class in org.springframework.hateoas.server.core
A LinkBuilderSupport extension that can keep a list of TemplateVariables around.
TemplateVariableAwareLinkBuilderSupport(UriComponentsBuilder, TemplateVariables, List<Affordance>) - Constructor for class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
 
TemplateVariableAwareLinkBuilderSupport(UriComponents, TemplateVariables, List<Affordance>) - Constructor for class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
 
TemplateVariables - Class in org.springframework.hateoas
Wrapper type for a collection of TemplateVariable.
TemplateVariables(TemplateVariable...) - Constructor for class org.springframework.hateoas.TemplateVariables
Creates a new TemplateVariables for the given TemplateVariables.
TemplateVariables(List<TemplateVariable>) - Constructor for class org.springframework.hateoas.TemplateVariables
Creates a new TemplateVariables for the given TemplateVariables.
TERMS_OF_SERVICE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the terms of service associated with the link's context.
TIMEGATE - Static variable in class org.springframework.hateoas.IanaLinkRelations
The Target IRI points to a TimeGate for an Original Resource.
TIMEMAP - Static variable in class org.springframework.hateoas.IanaLinkRelations
The Target IRI points to a TimeMap for an Original Resource.
toCollectionModel(Iterable<? extends T>) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
 
toCollectionModel(Flux<? extends T>, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.ReactiveRepresentationModelAssembler
Converts an Iterable or Ts into an Iterable of RepresentationModel and wraps them in a CollectionModel instance.
toCollectionModel(Flux<? extends T>, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.SimpleReactiveRepresentationModelAssembler
Converts all given entities into resources and wraps the collection as a resource as well.
toCollectionModel(Iterable<? extends T>) - Method in interface org.springframework.hateoas.server.RepresentationModelAssembler
Converts an Iterable or Ts into an Iterable of RepresentationModel and wraps them in a CollectionModel instance.
toCollectionModel(Iterable<? extends T>) - Method in interface org.springframework.hateoas.server.SimpleRepresentationModelAssembler
Converts all given entities into resources and wraps the collection as a resource as well.
toEntity(Class<T>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Returns the raw ResponseEntity with the representation unmarshalled into an instance of the given type.
toLink(Function<WebFluxLinkBuilder, Mono<Link>>) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
General callback to produce a Link from the given WebFluxLinkBuilder.
toList() - Method in class org.springframework.hateoas.Links
Returns the current Links as List.
toModel(T, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.ReactiveRepresentationModelAssembler
Converts the given entity into a D, which extends RepresentationModel.
toModel(T, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.SimpleReactiveRepresentationModelAssembler
Converts the given entity into a EntityModel wrapped in a Mono.
toModel(T) - Method in interface org.springframework.hateoas.server.RepresentationModelAssembler
Converts the given entity into a D, which extends RepresentationModel.
toModel(T) - Method in interface org.springframework.hateoas.server.SimpleRepresentationModelAssembler
Converts the given entity into a EntityModel.
toMono() - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
Returns the underlying Mono of Link for further handling within a reactive pipeline.
toMono(Function<Link, Link>) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
Returns a Mono of Link with the current one augmented by the given Function.
toObject(Class<T>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Executes the traversal and marshals the final response into an object of the given type.
toObject(ParameterizedTypeReference<T>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Executes the traversal and marshals the final response into an object of the given ParameterizedTypeReference.
toObject(String) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Executes the traversal and returns the result of the given JSON Path expression evaluated against the final representation.
toString() - Method in class org.springframework.hateoas.CollectionModel
 
toString() - Method in class org.springframework.hateoas.EntityModel
 
toString() - Method in class org.springframework.hateoas.Link
 
toString() - Method in class org.springframework.hateoas.Links
 
toString() - Method in enum org.springframework.hateoas.mediatype.alps.Format
 
toString() - Method in enum org.springframework.hateoas.mediatype.alps.Type
 
toString() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
toString() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
 
toString() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
 
toString() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
 
toString() - Method in class org.springframework.hateoas.PagedModel
 
toString() - Method in class org.springframework.hateoas.RepresentationModel
 
toString() - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
toString() - Method in class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
 
toString() - Method in class org.springframework.hateoas.TemplateVariable
 
toString() - Method in enum org.springframework.hateoas.TemplateVariable.VariableType
 
toString() - Method in class org.springframework.hateoas.TemplateVariables
 
toString() - Method in class org.springframework.hateoas.UriTemplate
 
toUri() - Method in class org.springframework.hateoas.Link
Returns the current href as URI after expanding the links without any arguments, i.e. all optional URI TemplateVariables will be dropped.
toUri() - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
toUri() - Method in interface org.springframework.hateoas.server.LinkBuilder
Creates a URI of the link built by the current builder instance.
toUriComponentsBuilder() - Method in class org.springframework.hateoas.server.mvc.ControllerLinkBuilder
Deprecated.
Returns a UriComponentsBuilder to continue to build the already built URI in a more fine grained way.
toUriComponentsBuilder() - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
Returns a UriComponentsBuilder to continue to build the already built URI in a more fine grained way.
Traverson - Class in org.springframework.hateoas.client
Component to ease traversing hypermedia APIs by following links with relation types.
Traverson(URI, MediaType...) - Constructor for class org.springframework.hateoas.client.Traverson
Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.
Traverson(URI, List<MediaType>) - Constructor for class org.springframework.hateoas.client.Traverson
Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.
Traverson.TraversalBuilder - Class in org.springframework.hateoas.client
Builder API to customize traversals.
TraversonDefaults - Interface in org.springframework.hateoas.client
SPI that exposes HttpMessageConverters and LinkDiscoverers to be used by default by Traverson.
TrueOnlyBooleanSerializer() - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
TYPE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.
Type - Enum in org.springframework.hateoas.mediatype.alps
An enum for ALPS descriptor types
TypeConstrainedMappingJackson2HttpMessageConverter - Class in org.springframework.hateoas.server.mvc
Extension of MappingJackson2HttpMessageConverter to constrain the ability to read and write HTTP message based on the target type.
TypeConstrainedMappingJackson2HttpMessageConverter(Class<?>) - Constructor for class org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
Creates a new TypeConstrainedMappingJackson2HttpMessageConverter for the given type.
TypeConstrainedMappingJackson2HttpMessageConverter(Class<?>, List<MediaType>, ObjectMapper) - Constructor for class org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
Convenience constructor to supply all parameters at once.
TypedEntityLinks<T> - Class in org.springframework.hateoas.server
Entity links API to create Links and LinkBuilder instances based on an identifier function.
TypedEntityLinks() - Constructor for class org.springframework.hateoas.server.TypedEntityLinks
 
TypedEntityLinks.ExtendedTypedEntityLinks<T> - Class in org.springframework.hateoas.server
Extension of TypedEntityLinks that exposes the ability to create links to collection resources as well.
typeIdResolverInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
 
TypeReferences - Class in org.springframework.hateoas.server.core
Helper to easily create ParameterizedTypeReference instances to Spring HATEOAS resource types.
TypeReferences() - Constructor for class org.springframework.hateoas.server.core.TypeReferences
 
TypeReferences.CollectionModelType<T> - Class in org.springframework.hateoas.server.core
A ParameterizedTypeReference to return a CollectionModel of some type.
TypeReferences.EntityModelType<T> - Class in org.springframework.hateoas.server.core
A ParameterizedTypeReference to return a EntityModel of some type.
TypeReferences.PagedModelType<T> - Class in org.springframework.hateoas.server.core
A ParameterizedTypeReference to return a PagedModel of some type.
typeResolverBuilderInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
 

U

UBER_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/vnd.amundsen-uber+json.
UBER_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.UBER_JSON_VALUE.
UberLinkDiscoverer - Class in org.springframework.hateoas.mediatype.uber
Find links by rel in an UBER+JSON representation.
uncuried(String) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Creates a new uncuried HalLinkRelation.
UP - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a parent document in a hierarchy of documents.
UriComponentsContributor - Interface in org.springframework.hateoas.server.mvc
SPI callback to enhance a UriComponentsBuilder when referring to a method through a dummy method invocation.
UriTemplate - Class in org.springframework.hateoas
Custom URI template to support qualified URI template variables.
UriTemplate(String) - Constructor for class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate using the given template string.
UriTemplate(String, TemplateVariables) - Constructor for class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate from the given base URI and TemplateVariables.
UriTemplateFactory - Class in org.springframework.hateoas.server.core
Builds and caches UriTemplate instances.
UriTemplateFactory() - Constructor for class org.springframework.hateoas.server.core.UriTemplateFactory
 

V

value() - Method in interface org.springframework.hateoas.LinkRelation
Return the link relation's value.
value() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
valueOf(String) - Static method in enum org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.springframework.hateoas.Link
Factory method to easily create Link instances from RFC-5988 compatible String representations of a link.
valueOf(String) - Static method in enum org.springframework.hateoas.Links.MergeMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.springframework.hateoas.Links
Deprecated.
valueOf(String) - Static method in enum org.springframework.hateoas.mediatype.alps.Format
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.hateoas.mediatype.alps.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.hateoas.mediatype.hal.HalConfiguration.RenderSingleLinks
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.hateoas.support.WebStack
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.Links.MergeMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.mediatype.alps.Format
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.mediatype.alps.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.mediatype.hal.HalConfiguration.RenderSingleLinks
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.support.WebStack
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_HISTORY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a resource containing the version history for the context.
VIA - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies a resource that is the source of the information in the link's context.
VndError(String, String, Link...) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Creates a new VndErrors.VndError with the given logref, a message as well as some Links.
VndError() - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Protected default constructor to allow JAXB marshalling.
VndErrors - Class in org.springframework.hateoas.mediatype.vnderrors
A representation model class to be rendered as specified for the media type application/vnd.error.
VndErrors(String, String, Link...) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Creates a new VndErrors instance containing a single VndErrors.VndError with the given logref, message and optional Links.
VndErrors(VndErrors.VndError, VndErrors.VndError...) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Creates a new VndErrors wrapper for at least one VndErrors.VndError.
VndErrors(List<VndErrors.VndError>) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Creates a new VndErrors wrapper for the given VndErrors.
VndErrors() - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Protected default constructor to allow JAXB marshalling.
VndErrors.VndError - Class in org.springframework.hateoas.mediatype.vnderrors

W

WebClientConfigurer - Class in org.springframework.hateoas.config
Assembles ExchangeStrategies needed to wire a WebClient with hypermedia support.
WebClientConfigurer() - Constructor for class org.springframework.hateoas.config.WebClientConfigurer
 
WebFluxBuilder() - Constructor for class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
 
WebFluxLink() - Constructor for class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
 
WebFluxLinkBuilder - Class in org.springframework.hateoas.server.reactive
Utility for building reactive Links.
WebFluxLinkBuilder.WebFluxBuilder - Class in org.springframework.hateoas.server.reactive
 
WebFluxLinkBuilder.WebFluxLink - Class in org.springframework.hateoas.server.reactive
Intermediate representation of a Link within a reactive pipeline to easily add Affordances from method invocations.
WebHandler - Class in org.springframework.hateoas.server.core
Utility for taking a method invocation and extracting a LinkBuilder.
WebHandler() - Constructor for class org.springframework.hateoas.server.core.WebHandler
 
WebHandler.LinkBuilderCreator<T extends LinkBuilder> - Interface in org.springframework.hateoas.server.core
 
WEBMENTION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies a target URI that supports the Webmention protcol.
WebMvcLinkBuilder - Class in org.springframework.hateoas.server.mvc
Builder to ease building Link instances pointing to Spring MVC controllers.
WebMvcLinkBuilderFactory - Class in org.springframework.hateoas.server.mvc
Factory for LinkBuilderSupport instances based on the request mapping annotated on the given controller.
WebMvcLinkBuilderFactory() - Constructor for class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
 
WebStack - Enum in org.springframework.hateoas.support
Utility to glean what web stack is currently available.
with(TemplateVariables) - Method in class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate with the current TemplateVariables augmented with the given ones.
with(TemplateVariable) - Method in class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate with the given TemplateVariable added.
with(String, TemplateVariable.VariableType) - Method in class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate with a TemplateVariable with the given name and type added.
withAffordances(List<Affordance>) - Method in class org.springframework.hateoas.Link
Creats a new Link with the given Affordances.
withFreshBuilder(Function<UriComponentsBuilder, S>) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
Executes the given Function using a freshly cloned UriComponentsBuilder.
withHeaders(HttpHeaders) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
The HttpHeaders that shall be used for the requests of the traversal.
without(LinkRelation) - Method in class org.springframework.hateoas.Links
Returns a Links with all Links with the given LinkRelation removed.
withParameter(String, Object) - Method in class org.springframework.hateoas.client.Hop
Add one parameter to the map of parameters.
withRel(LinkRelation) - Method in class org.springframework.hateoas.Link
Creates a new Link with the same href but given LinkRelation.
withRel(String) - Method in class org.springframework.hateoas.Link
Creates a new Link with the same href but given LinkRelation.
withRel(LinkRelation) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
withRel(String) - Method in interface org.springframework.hateoas.server.LinkBuilder
Creates the Link built by the current builder instance with the given link relation.
withRel(LinkRelation) - Method in interface org.springframework.hateoas.server.LinkBuilder
Creates the Link built by the current builder instance with the given LinkRelation.
withRel(LinkRelation) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
Creates a new WebFluxLinkBuilder.WebFluxLink for the Link with the given LinkRelation
withRel(String) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
Creates a new WebFluxLinkBuilder.WebFluxLink for the Link with the given link relation.
withRenderSingleLinksFor(LinkRelation, HalConfiguration.RenderSingleLinks) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
Configures how to render a single link for a given particular LinkRelation.
withRenderSingleLinksFor(String, HalConfiguration.RenderSingleLinks) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
Configures how to render a single link for the given link relation pattern, i.e. this can be either a fixed link relation (like search), take wildcards to e.g. match links of a given curie (like acme:*) or even complete URIs (like http://api.acme.com/foo/**).
withSelfRel() - Method in class org.springframework.hateoas.Link
Returns a Link pointing to the same URI but with the self relation.
withSelfRel() - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
withSelfRel() - Method in interface org.springframework.hateoas.server.LinkBuilder
Creates the Link built by the current builder instance with the default self link relation.
withSelfRel() - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
withTemplateParameters(Map<String, Object>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Adds the given operations parameters to the traversal.
WORKING_COPY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a working copy for this resource.
WORKING_COPY_OF - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to the versioned resource from which this working copy was obtained.
wrap(Iterable<S>) - Static method in class org.springframework.hateoas.CollectionModel
Creates a new CollectionModel instance by wrapping the given domain class instances into a EntityModel.
wrap(Iterable<S>, PagedModel.PageMetadata) - Static method in class org.springframework.hateoas.PagedModel
Factory method to easily create a PagedModel instance from a set of entities and pagination metadata.
wrap(Object) - Method in class org.springframework.hateoas.server.core.EmbeddedWrappers
Creates a new EmbeddedWrapper that
wrap(Object, LinkRelation) - Method in class org.springframework.hateoas.server.core.EmbeddedWrappers
Creates a new EmbeddedWrapper with the given rel.
wrap(HttpEntity<S>) - Static method in class org.springframework.hateoas.server.core.HeaderLinksResponseEntity
Wraps the given HttpEntity into a HeaderLinksResponseEntity.
wrap(S) - Static method in class org.springframework.hateoas.server.core.HeaderLinksResponseEntity

_

_withValueTypeSerializer(TypeSerializer) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
_withValueTypeSerializer(TypeSerializer) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
_withValueTypeSerializer(TypeSerializer) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
A B C D E F G H I J K L M N O P Q R S T U V W _ 
Skip navigation links
Spring HATEOAS

Copyright © 2012-2019–2019 Pivotal, Inc.. All rights reserved.