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.
ABOUT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.ABOUT.
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
 
AbstractHalFormsOptions(String, String, Long, Long, Object) - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
 
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
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
 
addAllIf(boolean, Supplier<? extends Iterable<Link>>) - Method in class org.springframework.hateoas.RepresentationModel
Adds all Links produced by the given Supplier if the guard is true.
addIf(boolean, Supplier<Link>) - Method in class org.springframework.hateoas.RepresentationModel
Adds the Link produced by the given Supplier if the guard is true.
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.
addParameters(QueryParameter...) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
addParameters(QueryParameter...) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Adds the given QueryParameters to the Affordance to build.
afford(HttpMethod) - Method in class org.springframework.hateoas.mediatype.Affordances
Creates a new Affordances.AffordanceBuilder for the given HTTP method for further customization.
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(Map<MediaType, AffordanceModel>) - Constructor for class org.springframework.hateoas.Affordance
 
AffordanceModel - Class in org.springframework.hateoas
Collection of attributes needed to render any form of hypermedia.
AffordanceModel(String, Link, HttpMethod, AffordanceModel.InputPayloadMetadata, List<QueryParameter>, AffordanceModel.PayloadMetadata) - Constructor for class org.springframework.hateoas.AffordanceModel
 
AffordanceModel.InputPayloadMetadata - Interface in org.springframework.hateoas
Payload metadata for incoming requests.
AffordanceModel.Named - Interface in org.springframework.hateoas
A named component.
AffordanceModel.PayloadMetadata - Interface in org.springframework.hateoas
Metadata about payloads.
AffordanceModel.PropertyMetadata - Interface in org.springframework.hateoas
Metadata about the property model of a representation.
AffordanceModel.PropertyMetadataConfigured<T> - Interface in org.springframework.hateoas
SPI for a type that can get AffordanceModel.PropertyMetadata applied.
AffordanceModelFactory - Interface in org.springframework.hateoas.mediatype
SPI for media type implementations to create a specific AffordanceModel for a ConfiguredAffordance.
AffordanceOperations - Interface in org.springframework.hateoas.mediatype
Operations commons to all builder APIs.
Affordances - Class in org.springframework.hateoas.mediatype
Primary API to construct Affordance instances.
Affordances.AffordanceBuilder - Class in org.springframework.hateoas.mediatype
Deprecated.
since 1.3, refer to ConfiguredAffordance instead. Will be made private in 1.4.
afterConfigurerAdded(WebTestClient.Builder, WebHttpHandlerBuilder, ClientHttpConnector) - Method in class org.springframework.hateoas.config.HypermediaWebTestClientConfigurer
Register the proper Jackson2JsonEncoders and Jackson2JsonDecoders for a given WebTestClient.
afterPropertiesSet() - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
 
Alps - Class in org.springframework.hateoas.mediatype.alps
An ALPS document.
alps() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
Returns a new Alps.AlpsBuilder.
Alps.AlpsBuilder - Class in org.springframework.hateoas.mediatype.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
ALTERNATE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.ALTERNATE.
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.
and(Stream<Link>) - Method in class org.springframework.hateoas.Links
Creates a new Links instance with all given Links added.
andAfford(HttpMethod) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
andAfford(HttpMethod) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Concludes the creation of the current Affordance to build and starts a new one.
andAffordance(Affordance) - Method in class org.springframework.hateoas.Link
Create new Link with an additional Affordance.
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.
andIf(boolean, Link...) - Method in class org.springframework.hateoas.Links
Adds the given links if the given condition is true.
andIf(boolean, Supplier<Link>...) - Method in class org.springframework.hateoas.Links
Adds the given links if the given condition is true.
andIf(boolean, Stream<Link>) - Method in class org.springframework.hateoas.Links
Adds the given links if the given condition is true.
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
LinkRelationProvider that evaluates the Relation annotation on entity types.
AnnotationLinkRelationProvider() - Constructor for class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
 
AnnotationMappingDiscoverer - Class in org.springframework.hateoas.server.core
Deprecated.
since 1.2, not for removal but for hiding within the package in 1.3
AnnotationMappingDiscoverer(Class<? extends Annotation>) - Constructor for class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Deprecated.
Creates an AnnotationMappingDiscoverer for the given annotation type.
AnnotationMappingDiscoverer(Class<? extends Annotation>, String) - Constructor for class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Deprecated.
Creates an AnnotationMappingDiscoverer for the given annotation type and attribute name.
APPENDIX - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to an appendix.
APPENDIX_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.APPENDIX.
apply(AffordanceModel.PropertyMetadata) - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadataConfigured
applyTo(T) - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
Deprecated.
since 1.3, prefer setting up the model types via #createProperties(Function)
ARCHIVES - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a collection of records, documents, or other materials of historical interest.
ARCHIVES_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.ARCHIVES.
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 relation in the rels configured to follow.
ATOM_NAMESPACE - Static variable in class org.springframework.hateoas.Link
 
augmentClient(List<HttpMessageConverter<?>>) - Method in class org.springframework.hateoas.config.WebConverters
 
augmentServer(List<HttpMessageConverter<?>>) - Method in class org.springframework.hateoas.config.WebConverters
Augments the given List of HttpMessageConverters with the hypermedia enabled ones.
AUTHOR - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the context's author.
AUTHOR_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.AUTHOR.

B

BasicLinkBuilder - Class in org.springframework.hateoas.server.mvc
Simples LinkBuilder implementation possible.
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.
BLOCKED_BY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.BLOCKED_BY.
BOOKMARK - Static variable in class org.springframework.hateoas.IanaLinkRelations
Gives a permanent link to use for bookmarking purposes.
BOOKMARK_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.BOOKMARK.
build() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
build() - Method in class org.springframework.hateoas.mediatype.alps.Alps.AlpsBuilder
 
build() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
build() - Method in class org.springframework.hateoas.mediatype.alps.Doc.DocBuilder
 
build() - Method in class org.springframework.hateoas.mediatype.alps.Ext.ExtBuilder
 
build() - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Builds the Affordance currently under construction and returns in alongside the ones already contained in the Link the buildup started from.
build() - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Transform the entities and Links into a RepresentationModel.
builder() - Static method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
builder() - Static method in class org.springframework.hateoas.mediatype.alps.Doc
 
builder() - Static method in class org.springframework.hateoas.mediatype.alps.Ext
 

C

CachingMappingDiscoverer - Class in org.springframework.hateoas.server.core
Caching adapter of MappingDiscoverer.
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).
CANONICAL_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.CANONICAL.
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.
CHAPTER_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.CHAPTER.
CHECKBOX - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
CHECKBOX_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
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.
CITE_AS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.CITE_AS.
ClassUtils - Class in org.springframework.hateoas.support
 
ClassUtils() - Constructor for class org.springframework.hateoas.support.ClassUtils
 
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.
COLLECTION_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.COLLECTION.
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
Deprecated.
CollectionModel(Iterable<T>, Iterable<Link>) - Constructor for class org.springframework.hateoas.CollectionModel
Deprecated.
CollectionModelMixin<T> - Class in org.springframework.hateoas.mediatype.hal
Custom mixin to to render collection content as _embedded.
CollectionModelMixin() - Constructor for class org.springframework.hateoas.mediatype.hal.CollectionModelMixin
 
CollectionModelProcessorWrapper(RepresentationModelProcessor<?>) - Constructor for class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.CollectionModelProcessorWrapper
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.
COLOR - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
COLOR_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
compositeParameter(String) - Static method in class org.springframework.hateoas.TemplateVariable
Static helper to fashion TemplateVariable.VariableType.COMPOSITE_PARAM variables.
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.
conclude(Function<String, UriComponentsBuilder>, ConversionService) - Method in interface org.springframework.hateoas.server.core.WebHandler.PreparedWebHandler
 
ConfigurableAffordance - Interface in org.springframework.hateoas.mediatype
An affordance in creation.
ConfigurableHandlerInstantiator - Class in org.springframework.hateoas.mediatype
A HandlerInstantiator that will use instances explicitly registered with it but fall back to lookup or even create a fresh instance via the AutowireCapableBeanFactory provided on construction.
ConfigurableHandlerInstantiator(AutowireCapableBeanFactory) - Constructor for class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
ConfiguredAffordance - Interface in org.springframework.hateoas.mediatype
A configure affordance for inspection by media type implementations to create AffordanceModel instances.
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.
CONTENTS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.CONTENTS.
ControllerEntityLinks - Class in org.springframework.hateoas.server.core
EntityLinks implementation which assumes a certain URI mapping structure: A class-level ExposesResourceFor annotation to declare that the annotated controller exposes collection and item resources for.
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
 
ControllerLinkRelationProvider - Class in org.springframework.hateoas.server.mvc
LinkRelationProvider inspecting ExposesResourceFor annotations on controller classes.
ControllerLinkRelationProvider(Class<?>, PluginRegistry<LinkRelationProvider, LinkRelationProvider.LookupContext>) - 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.
CONVERTED_FROM_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.CONVERTED_FROM.
COPYRIGHT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a copyright statement that applies to the link's context.
COPYRIGHT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.COPYRIGHT.
create() - Static method in class org.springframework.hateoas.mediatype.problem.Problem
Returns an empty Problem instance.
create(T) - Static method in class org.springframework.hateoas.mediatype.problem.Problem
Returns an Problem.ExtendedProblem with the given payload as additional properties.
CREATE_FORM - Static variable in class org.springframework.hateoas.IanaLinkRelations
The target IRI points to a resource where a submission form can be obtained.
CREATE_FORM_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.CREATE_FORM.
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(UriComponents, List<Affordance>) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
Creates a new instance of the sub-class.
createNewInstance(UriComponents, List<Affordance>) - Method in class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
 
createNewInstance(UriComponents, List<Affordance>, TemplateVariables) - Method in class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
 
createNewInstance(UriComponents, List<Affordance>) - Method in class org.springframework.hateoas.server.mvc.BasicLinkBuilder
 
createNewInstance(UriComponents, List<Affordance>, TemplateVariables) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
 
createNewInstance(UriComponents, 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
 
createProperties(BiFunction<AffordanceModel.InputPayloadMetadata, AffordanceModel.PropertyMetadata, T>) - Method in class org.springframework.hateoas.AffordanceModel
Creates a List of properties based on the given creator.
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.
CURRENT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.CURRENT.
customize(T, Function<AffordanceModel.PropertyMetadata, T>) - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
 
customize(ObjectMapper) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Customizes the given ObjectMapper with the registered callback.
customize(ObjectMapper) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
 

D

DATE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
DATE_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
DATETIME_LOCAL - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
DATETIME_LOCAL_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
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
 
DEFAULTS_ONLY - Static variable in interface org.springframework.hateoas.mediatype.MessageResolver
 
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(LinkRelationProvider...) - Constructor for class org.springframework.hateoas.server.core.DelegatingLinkRelationProvider
DelegatingLinkRelationProvider(PluginRegistry<LinkRelationProvider, LinkRelationProvider.LookupContext>) - 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.
DESCRIBED_BY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.DESCRIBED_BY.
DESCRIBES - Static variable in class org.springframework.hateoas.IanaLinkRelations
The relationship A 'describes' B asserts that resource A provides a description of resource B.
DESCRIBES_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.DESCRIBES.
descriptor(List<Descriptor>) - Method in class org.springframework.hateoas.mediatype.alps.Alps.AlpsBuilder
 
descriptor() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
Descriptor - Class in org.springframework.hateoas.mediatype.alps
A value object for an ALPS descriptor.
descriptor(List<Descriptor>) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
Descriptor.DescriptorBuilder - Class in org.springframework.hateoas.mediatype.alps
 
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.ConfigurableHandlerInstantiator
 
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.
DISCLOSURE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.DISCLOSURE.
DISCOVERER - Static variable in class org.springframework.hateoas.server.core.SpringAffordanceBuilder
 
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.
DNS_PREFETCH_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.DNS_PREFETCH.
doc(Doc) - Method in class org.springframework.hateoas.mediatype.alps.Alps.AlpsBuilder
 
doc() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
Returns a new Doc.DocBuilder.
doc(Doc) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
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.
Doc.DocBuilder - Class in org.springframework.hateoas.mediatype.alps
 
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.
DUPLICATE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.DUPLICATE.

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_FORM_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.EDIT_FORM.
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.
EDIT_MEDIA_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.EDIT_MEDIA.
EDIT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.EDIT.
EMAIL - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
EMAIL_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
embed(Object, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embed the entity and associate it with the LinkRelation.
embed(Object) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embeds the given entity into the RepresentationModel.
embed(Collection<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embeds the given collection in the RepresentationModel.
embed(Collection<?>, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embeds the given collection in the RepresentationModel and the LinkRelation derived from the given type.
embed(Collection<?>, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embeds the given collection in the RepresentationModel for the given LinkRelation.
embed(Stream<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embeds the given Stream in the RepresentationModel.
embed(Stream<?>, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embeds the given Stream in the RepresentationModel and the LinkRelation derived from the given type.
embed(Stream<?>, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embeds the given Stream in the RepresentationModel for the given LinkRelation.
EmbeddedMapper(LinkRelationProvider, CurieProvider, boolean) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper
 
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.CollectionModel
Creates a new empty collection model.
empty(Link...) - Static method in class org.springframework.hateoas.CollectionModel
Creates a new empty collection model with the given links.
empty(Iterable<Link>) - Static method in class org.springframework.hateoas.CollectionModel
Creates a new empty collection model with the given links.
empty() - Static method in class org.springframework.hateoas.PagedModel
Creates an empty PagedModel.
empty(Link...) - Static method in class org.springframework.hateoas.PagedModel
Creates an empty PagedModel with the given links.
empty(Iterable<Link>) - Static method in class org.springframework.hateoas.PagedModel
Creates an empty PagedModel with the given links.
empty(PagedModel.PageMetadata) - Static method in class org.springframework.hateoas.PagedModel
Creates an empty PagedModel with the given PagedModel.PageMetadata.
empty(PagedModel.PageMetadata, Link...) - Static method in class org.springframework.hateoas.PagedModel
Creates an empty PagedModel with the given PagedModel.PageMetadata and links.
empty(PagedModel.PageMetadata, Iterable<Link>) - Static method in class org.springframework.hateoas.PagedModel
Creates an empty PagedModel with the given PagedModel.PageMetadata and links.
emptyCollectionOf(Class<?>) - Method in class org.springframework.hateoas.server.core.EmbeddedWrappers
Creates an EmbeddedWrapper for an empty Collection with the given element type.
emptyHalModel() - Static method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Creates a new HalModelBuilder without a primary payload.
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.
ENCLOSURE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.ENCLOSURE.
enhance(UriComponentsBuilder, MethodParameter, Object) - Method in interface org.springframework.hateoas.server.mvc.UriComponentsContributor
Enhance the given UriComponentsBuilder with the given value.
entity(Object) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Embed the entity, but with no relation.
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
Deprecated.
since 1.1, use EntityModel.of(Object, Link...) instead.
EntityModel(T, Iterable<Link>) - Constructor for class org.springframework.hateoas.EntityModel
Deprecated.
since 1.1, use EntityModel.of(Object, Iterable) instead.
EntityModelType() - Constructor for class org.springframework.hateoas.server.core.TypeReferences.EntityModelType
 
equals(Object) - Method in class org.springframework.hateoas.Affordance
 
equals(Object) - Method in class org.springframework.hateoas.AffordanceModel
 
equals(Object) - Method in class org.springframework.hateoas.client.Hop
 
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.Link
 
equals(Object) - Method in class org.springframework.hateoas.Links
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.alps.Alps
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.alps.Doc
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.alps.Ext
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
equals(Object) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
 
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.QueryParameter
 
equals(Object) - Method in class org.springframework.hateoas.RepresentationModel
 
equals(Object) - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
 
equals(Object) - Method in class org.springframework.hateoas.TemplateVariable
 
equals(Object) - Method in class org.springframework.hateoas.TemplateVariables
 
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, ?>) - 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, ?>) - 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 Ext.ExtBuilder.
ext(Ext) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
Ext - Class in org.springframework.hateoas.mediatype.alps
A value object for an ALPS ext element.
Ext.ExtBuilder - Class in org.springframework.hateoas.mediatype.alps
 
ExtendedProblem(T) - Constructor for class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
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
 
extractPropertyValues(Object) - Static method in class org.springframework.hateoas.mediatype.PropertyUtils
 

F

FILE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
FILE_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
findInstance(Class<T>) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
 
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
 
findOrCreateInstance(Class<T>) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
 
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.
FIRST_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.FIRST.
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.
forCollectionResourceRelLookup(Class<?>) - Static method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
Creates a LinkRelationProvider.LookupContext to lookup the collection resource relation for the given type.
forItemResourceRelLookup(Class<?>) - Static method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
Creates a LinkRelationProvider.LookupContext to lookup the item resource relation for the given type.
forLink(Link) - Method in interface org.springframework.hateoas.mediatype.hal.HalModelBuilder.PreviewBuilder
Concludes the set up of a preview for the given Link.
forLink(String, LinkRelation) - Method in interface org.springframework.hateoas.mediatype.hal.HalModelBuilder.PreviewBuilder
Concludes the set up of a preview for the Link consisting ot the given href and LinkRelation.
format(Format) - Method in class org.springframework.hateoas.mediatype.alps.Doc.DocBuilder
 
Format - Enum in org.springframework.hateoas.mediatype.alps
Enum for all ALPS doc formats.
forType(Function<T, ?>) - 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.
forType(Class<?>) - Static method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
Creates a LinkRelationProvider.LookupContext for the type in general, i.e. both item and collection relation lookups.
fragment(String) - Static method in class org.springframework.hateoas.TemplateVariable
Static helper to fashion TemplateVariable.VariableType.FRAGMENT variables.
from(AffordanceModel.PayloadMetadata) - Static method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
 
from(Class<?>) - Static method in class org.springframework.hateoas.mediatype.html.HtmlInputType
Returns the HtmlInputType derived from the given ResolvableType.
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, AffordanceModel.InputPayloadMetadata, List<QueryParameter>, AffordanceModel.PayloadMetadata) - Method in interface org.springframework.hateoas.mediatype.AffordanceModelFactory
Deprecated.
since 1.3 in favor of AffordanceModelFactory.getAffordanceModel(ConfiguredAffordance). Will be removed in 1.4.
getAffordanceModel(ConfiguredAffordance) - Method in interface org.springframework.hateoas.mediatype.AffordanceModelFactory
Return the AffordanceModel for the given ConfiguredAffordance.
getAffordances() - Method in class org.springframework.hateoas.Link
Returns safe copy of Affordances.
getAffordances() - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
 
getAffordances(Class<?>, Method, String) - Static method in class org.springframework.hateoas.server.core.SpringAffordanceBuilder
Returns all Affordances for the given type's method and base URI.
getAnnotationType() - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
Returns the annotation type.
getArguments() - Method in interface org.springframework.hateoas.server.core.MethodInvocation
 
getAvailableConfigurations() - Method in enum org.springframework.hateoas.support.WebStack
Based on what client/server components are on the classpath, return what configuration classes should be registered.
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.
getConsumes(Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Deprecated.
 
getConsumes(Method) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
 
getConsumes(Method) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
Returns the MediaTypes supported for consumption.
getContent() - Method in class org.springframework.hateoas.CollectionModel
Returns the underlying elements.
getContent() - Method in class org.springframework.hateoas.EntityModel
Returns the underlying entity.
getContent() - Method in class org.springframework.hateoas.mediatype.hal.CollectionModelMixin
 
getContent() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
Returns the underlying elements.
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
 
getControllerClass() - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
 
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
 
getDefaultMessage() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
getDefaultMessageConverters(MediaType...) - Static method in class org.springframework.hateoas.client.Traverson
Returns all HttpMessageConverters that will be registered for the given MediaTypes by default.
getDeprecation() - Method in class org.springframework.hateoas.Link
 
getDeprecation() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getDescription() - Method in class org.springframework.hateoas.TemplateVariable
 
getDescriptor() - Method in class org.springframework.hateoas.mediatype.alps.Alps
 
getDescriptor() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getDetail() - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
getDoc() - Method in class org.springframework.hateoas.mediatype.alps.Alps
 
getDoc() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getExposedProperties(Class<?>) - Static method in class org.springframework.hateoas.mediatype.PropertyUtils
 
getExposedProperties(ResolvableType) - Static method in class org.springframework.hateoas.mediatype.PropertyUtils
Returns the AffordanceModel.InputPayloadMetadata model for the given ResolvableType.
getExt() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getFormat() - Method in class org.springframework.hateoas.mediatype.alps.Doc
 
getHalConfiguration() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Returns the underlying HalConfiguration.
getHref() - Method in class org.springframework.hateoas.Link
 
getHref() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getHref() - Method in class org.springframework.hateoas.mediatype.alps.Doc
 
getHref() - Method in class org.springframework.hateoas.mediatype.alps.Ext
 
getHreflang() - Method in class org.springframework.hateoas.Link
 
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.
getHttpMethod() - Method in class org.springframework.hateoas.AffordanceModel
 
getI18nCodes() - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
Returns the I18n codes to be used to resolve a name for the payload metadata.
getId() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getId() - Method in class org.springframework.hateoas.mediatype.alps.Ext
 
getInline() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.Inline
Returns the inline values.
getInput() - Method in class org.springframework.hateoas.AffordanceModel
 
getInputMetadata() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
getInputMetadata() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
Metadata about the input payload.
getInputType() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Returns the input type of the property.
getInputType(Class<?>) - Method in interface org.springframework.hateoas.mediatype.InputTypeFactory
Derive an input type from the given ResolvableType.
getInstance() - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
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
 
getLastInvocationAware(Object) - Static method in class org.springframework.hateoas.server.core.DummyInvocationUtils
Returns the LastInvocationAware instance from the given source, that essentially has to be a proxy created via DummyInvocationUtils.methodOn(Class, Object...) and subsequent linkTo(…) calls.
getLink() - Method in class org.springframework.hateoas.AffordanceModel
 
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() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.Remote
Returns the Link pointing to the resource returning option values.
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.
getLocalPart() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
getLogref() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
getLogref() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
 
getMapping(Class<?>) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Deprecated.
 
getMapping(Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Deprecated.
 
getMapping(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Deprecated.
 
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.
getMapping(Class<?>, Method) - Static method in class org.springframework.hateoas.server.core.SpringAffordanceBuilder
Returns the mapping for the given type's method.
getMax() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Return the maximum value allowed for a numeric type.
getMaxItems() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
 
getMaxItems() - Method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
Returns the maximum number of items to be selected.
getMaxLength() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Return the maximum length allowed for a string type.
getMedia() - Method in class org.springframework.hateoas.Link
 
getMediaType() - Method in interface org.springframework.hateoas.mediatype.AffordanceModelFactory
Declare the MediaType this factory supports.
getMediaTypes() - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
Returns the MediaType that the payload requires.
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
Deprecated.
 
getMessage() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
 
getMetadata() - Method in class org.springframework.hateoas.PagedModel
Returns the pagination metadata.
getMethod() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
getMethod() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
The HttpMethod of the affordance.
getMethod() - Method in interface org.springframework.hateoas.server.core.MethodInvocation
 
getMin() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Return the minimum value allowed for a numeric type.
getMinItems() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
 
getMinItems() - Method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
Returns the minimum number of items to be selected.
getMinLength() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Return the minimum length allowed for a string type.
getName() - Method in class org.springframework.hateoas.AffordanceModel
 
getName() - Method in interface org.springframework.hateoas.AffordanceModel.Named
 
getName() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
The name of the property.
getName() - Method in class org.springframework.hateoas.Link
 
getName() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getName() - Method in class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider.Curie
 
getName() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getName() - Method in class org.springframework.hateoas.QueryParameter
 
getName() - Method in class org.springframework.hateoas.TemplateVariable
 
getNameOrDefault() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
getNameOrDefault() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
Returns the explicitly configured name of the Affordance or calculates a default based on the HttpMethod and type backing it.
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
 
getOutput() - Method in class org.springframework.hateoas.AffordanceModel
 
getOutputMetadata() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
getOutputMetadata() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
Metadata about the output payload.
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.
getPath() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
 
getPattern() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Returns the (regular expression) pattern the property has to adhere to.
getPreviousLink() - Method in class org.springframework.hateoas.PagedModel
Returns the Link pointing to the previous page (if set).
getPrimaryMediaType() - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
Returns the primary MediaType expected for the input.
getProfile() - Method in class org.springframework.hateoas.Link
 
getProfile() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getPrompt() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue
Returns the prompt to be used.
getPromptField() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
 
getPromptField() - Method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
The field to look up the prompt from.
getProperties() - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
Returns the additional properties.
getPropertyMetadata(String) - Method in interface org.springframework.hateoas.AffordanceModel.PayloadMetadata
 
getQueryMethodParameters() - Method in class org.springframework.hateoas.AffordanceModel
 
getQueryParameters() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
getQueryParameters() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
The parameters of the affordance.
getRel() - Method in class org.springframework.hateoas.Link
 
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.
getRenderSingleLinks() - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
 
getRequestMethod(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
Deprecated.
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.
getResourceType() - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
 
getRootType() - Method in interface org.springframework.hateoas.config.HypermediaMappingInformation
Return the type that this hypermedia type is represented by.
getRt() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getSchema(SerializerProvider, Type) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
getSelectedValue() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
 
getSelectedValue() - Method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
 
getSize() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
Returns the requested size of the page.
getStatus() - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
getTarget() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
getTarget() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
Returns the affordance's target.
getTargetType() - Method in interface org.springframework.hateoas.server.core.MethodInvocation
 
getTemplate() - Method in class org.springframework.hateoas.Link
 
getThis() - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
Returns the current concrete instance.
getThis() - Method in class org.springframework.hateoas.server.mvc.BasicLinkBuilder
 
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.Link
 
getTitle() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getTitle() - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
getTotal() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
Virtual attribute to generate JSON field of total.
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 interface org.springframework.hateoas.AffordanceModel.PayloadMetadata
 
getType() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Return the type of the property.
getType() - Method in class org.springframework.hateoas.Link
 
getType() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
getType() - Method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
getType() - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
getType() - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
 
getType() - Method in class org.springframework.hateoas.TemplateVariable
 
getURI() - Method in class org.springframework.hateoas.AffordanceModel
Expand the Link into an href with no parameters.
getValue() - Method in class org.springframework.hateoas.mediatype.alps.Doc
 
getValue() - Method in class org.springframework.hateoas.mediatype.alps.Ext
 
getValue() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue
Returns the value.
getValue() - Method in class org.springframework.hateoas.QueryParameter
 
getValue() - Method in interface org.springframework.hateoas.server.core.EmbeddedWrapper
Returns the actual value to embed.
getValueField() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
 
getValueField() - Method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
The field to use as the value to be sent.
getValueFrom(MethodParameter) - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
Reads the Annotation attribute's value from the given MethodParameter.
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.
getVersion() - Method in class org.springframework.hateoas.mediatype.alps.Alps
 
GLOSSARY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a glossary of terms.
GLOSSARY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.GLOSSARY.

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_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.
HalFormsConfiguration - Class in org.springframework.hateoas.mediatype.hal.forms
HAL-FORMS specific configuration extension of HalConfiguration.
HalFormsConfiguration() - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Creates a new HalFormsConfiguration backed by a default HalConfiguration.
HalFormsConfiguration(HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Creates a new HalFormsConfiguration for the given HalConfiguration.
HalFormsLinkDiscoverer - Class in org.springframework.hateoas.mediatype.hal.forms
HAL-FORMS based JsonPathLinkDiscoverer.
HalFormsLinkDiscoverer() - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsLinkDiscoverer
 
HalFormsOptions - Interface in org.springframework.hateoas.mediatype.hal.forms
Representation of HAL-FORMS options attribute.
HalFormsOptions.AbstractHalFormsOptions<T extends HalFormsOptions.AbstractHalFormsOptions<T>> - Class in org.springframework.hateoas.mediatype.hal.forms
 
HalFormsOptions.Inline - Class in org.springframework.hateoas.mediatype.hal.forms
 
HalFormsOptions.Remote - Class in org.springframework.hateoas.mediatype.hal.forms
Representation of a remote options element.
HalFormsPromptedValue - Class in org.springframework.hateoas.mediatype.hal.forms
A value object to describe prompted values for HAL-FORMS options' inline attribute or responses of resources pointed to by the link object.
HalHandlerInstantiator(LinkRelationProvider, CurieProvider, MessageResolver) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
Convenience constructor for testing purposes.
HalHandlerInstantiator(LinkRelationProvider, CurieProvider, MessageResolver, HalConfiguration, AutowireCapableBeanFactory) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
 
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, MessageResolver, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer
 
HalLinkListSerializer(BeanProperty, CurieProvider, Jackson2HalModule.EmbeddedMapper, MessageResolver, 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.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>, MessageResolver, AutowireCapableBeanFactory) - Constructor for class org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration
 
halModel() - Static method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Creates a new HalModelBuilder.
halModel(EmbeddedWrappers) - Static method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Creates a new HalModelBuilder using the given EmbeddedWrappers.
HalModelBuilder - Class in org.springframework.hateoas.mediatype.hal
Builder API to create complex HAL representations exposing a HAL idiomatic API.
HalModelBuilder.PreviewBuilder - Interface in org.springframework.hateoas.mediatype.hal
 
halModelOf(Object) - Static method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Creates a new HalModelBuilder with the given entity as primary payload.
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, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
HalResourcesSerializer(Jackson2HalModule.EmbeddedMapper, HalConfiguration, BeanProperty) - Constructor for class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
 
handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorHandlerMethodReturnValueHandler
 
handlesType(Class<?>) - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
Returns whether the lookup is executed for the given type.
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.Affordance
 
hashCode() - Method in class org.springframework.hateoas.AffordanceModel
 
hashCode() - Method in class org.springframework.hateoas.client.Hop
 
hashCode() - Method in class org.springframework.hateoas.CollectionModel
 
hashCode() - Method in class org.springframework.hateoas.EntityModel
 
hashCode() - Method in class org.springframework.hateoas.Link
 
hashCode() - Method in class org.springframework.hateoas.Links
 
hashCode() - Method in class org.springframework.hateoas.mediatype.alps.Alps
 
hashCode() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
hashCode() - Method in class org.springframework.hateoas.mediatype.alps.Doc
 
hashCode() - Method in class org.springframework.hateoas.mediatype.alps.Ext
 
hashCode() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
hashCode() - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
hashCode() - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
hashCode() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
hashCode() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
 
hashCode() - Method in class org.springframework.hateoas.PagedModel
 
hashCode() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
 
hashCode() - Method in class org.springframework.hateoas.QueryParameter
 
hashCode() - Method in class org.springframework.hateoas.RepresentationModel
 
hashCode() - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
 
hashCode() - Method in class org.springframework.hateoas.TemplateVariable
 
hashCode() - Method in class org.springframework.hateoas.TemplateVariables
 
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.
hasName(String) - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Whether the property has the given name.
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.
HateoasConfiguration - Class in org.springframework.hateoas.config
Common HATEOAS specific configuration.
HateoasConfiguration() - Constructor for class org.springframework.hateoas.config.HateoasConfiguration
 
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.
HELP_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.HELP.
HIDDEN - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
HIDDEN_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
Hop - Class in org.springframework.hateoas.client
Container for customizations to a single traverson "hop"
HOSTS - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource hosted by the server indicated by the link context.
HOSTS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.HOSTS.
href(String) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
href(String) - Method in class org.springframework.hateoas.mediatype.alps.Doc.DocBuilder
 
href(String) - Method in class org.springframework.hateoas.mediatype.alps.Ext.ExtBuilder
 
HtmlInputType - Class in org.springframework.hateoas.mediatype.html
The types of HTML <input … /> elements.
HTTP_PROBLEM_DETAILS_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/problem+json.
HTTP_PROBLEM_DETAILS_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
HUB - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a hub that enables registration for notification of updates to the context.
HUB_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.HUB.
hypermediaExchangeStrategies() - Method in class org.springframework.hateoas.config.WebClientConfigurer
Deprecated.
Return a set of ExchangeStrategies driven by registered EnableHypermediaSupport.HypermediaTypes.
HypermediaMappingInformation - Interface in org.springframework.hateoas.config
Interface for registering custom hypermedia handlers.
HypermediaRestTemplateConfigurer - Class in org.springframework.hateoas.config
Assembles hypermedia-based message converters and applies them to an existing RestTemplate.
HypermediaWebClientConfigurer - Class in org.springframework.hateoas.config
Assembles Jackson2JsonEncoders and Jackson2JsonDecoders needed to wire a WebClient with hypermedia support.
HypermediaWebTestClientConfigurer - Class in org.springframework.hateoas.config
Assembles Jackson2JsonEncoders and Jackson2JsonDecoders needed to wire a WebTestClient with hypermedia support.

I

IanaLinkRelations - Class in org.springframework.hateoas
Capture standard IANA-based link relations.
IanaUriSchemes - Class in org.springframework.hateoas
A list of well-defined URI schemes governed by IANA.
IanaUriSchemes() - Constructor for class org.springframework.hateoas.IanaUriSchemes
 
ICON - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to an icon representing the link's context.
ICON_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.ICON.
id(String) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
id(String) - Method in class org.springframework.hateoas.mediatype.alps.Ext.ExtBuilder
 
INDEX - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to an index.
INDEX_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INDEX.
inline(T...) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
Creates a new HalFormsOptions.Inline options representation listing the given values.
inline(Collection<? extends Object>) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
Creates a new HalFormsOptions.Inline options representation listing the given collection of values.
InputType - Annotation Type in org.springframework.hateoas
Annotation to declare a dedicated input type for a property of an representation model.
InputTypeFactory - Interface in org.springframework.hateoas.mediatype
SPI interface for components that can derive an input type from a ResolvableType.
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_AFTER_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_AFTER.
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_BEFORE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_BEFORE.
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_CONTAINS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_CONTAINS.
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_DISJOINT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_DISJOINT.
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_DURING_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_DURING.
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_EQUALS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_EQUALS.
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_FINISHED_BY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
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_FINISHES_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_FINISHES.
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_IN_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_IN.
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_MEETS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_MEETS.
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_MET_BY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_MET_BY.
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_OVERLAPPED_BY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
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_OVERLAPS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_OVERLAPS.
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_STARTED_BY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
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
INTERVAL_STARTS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.INTERVAL_STARTS.
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.
isApplyPropertyNamingStrategy() - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
 
isAvailable() - Method in enum org.springframework.hateoas.support.WebStack
Deprecated.
Will be removed in 1.2 in light of WebStack.getAvailableConfigurations().
isCollectionRelationLookup() - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
Returns whether the current context includes the collection relation lookup.
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
 
isEnforceEmbeddedCollections() - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
 
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?
isIanaUriScheme(String) - Static method in class org.springframework.hateoas.IanaUriSchemes
 
isItemRelationLookup() - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
Returns whether the current context includes the item relation lookup.
isOptional() - Method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns whether the variable of this type is optional.
isReadOnly() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Whether the property is read only, i.e. must not be manipulated in requests modifying state.
isRequired() - Method in interface org.springframework.hateoas.AffordanceModel.PropertyMetadata
Whether the property is required to be submitted or always present in the representation returned.
isRequired() - Method in class org.springframework.hateoas.QueryParameter
 
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.
ITEM_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.ITEM.
iterator() - Method in class org.springframework.hateoas.Affordance
 
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
Deprecated.
 
iterator() - Method in class org.springframework.hateoas.TemplateVariables
 
iterator() - Method in class org.springframework.hateoas.UriTemplate
 

J

Jackson2CollectionJsonModule - Class in org.springframework.hateoas.mediatype.collectionjson
Jackson 2 module implementation to render CollectionModel, EntityModel, and RepresentationModel instances in Collection+JSON compatible JSON.
Jackson2CollectionJsonModule() - Constructor for class org.springframework.hateoas.mediatype.collectionjson.Jackson2CollectionJsonModule
 
Jackson2HalFormsModule - Class in org.springframework.hateoas.mediatype.hal.forms
Serialize / deserialize all the parts of HAL-FORMS documents using Jackson.
Jackson2HalFormsModule() - Constructor for class org.springframework.hateoas.mediatype.hal.forms.Jackson2HalFormsModule
 
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.ConfigurableHandlerInstantiator
 

L

LAST - Static variable in class org.springframework.hateoas.IanaLinkRelations
An IRI that refers to the furthest following resource in a series of resources.
LAST_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.LAST.
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.
LATEST_VERSION_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.LATEST_VERSION.
LICENSE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a license associated with this context.
LICENSE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.LICENSE.
Link - Class in org.springframework.hateoas
Value object for links.
Link(String) - Constructor for class org.springframework.hateoas.Link
Deprecated.
since 1.1, use Link.of(String)
Link(String, String) - Constructor for class org.springframework.hateoas.Link
Deprecated.
since 1.1, use Link.of(String, String).
Link(String, LinkRelation) - Constructor for class org.springframework.hateoas.Link
Deprecated.
Link(UriTemplate, String) - Constructor for class org.springframework.hateoas.Link
Deprecated.
Link(UriTemplate, LinkRelation) - Constructor for class org.springframework.hateoas.Link
Deprecated.
Link() - Constructor for class org.springframework.hateoas.Link
Empty constructor required by the marshaling framework.
link(Link) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Add a Link to the whole thing.
link(String, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Adds a Link with the given href and LinkRelation to the RepresentationModel to be built.
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(UriComponents) - Constructor for class org.springframework.hateoas.server.core.LinkBuilderSupport
Creates a new LinkBuilderSupport using the given UriComponents.
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 class org.springframework.hateoas.server.core.DelegatingEntityLinks
 
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.
LinkRelationProvider.LookupContext - Class in org.springframework.hateoas.server
Links - Class in org.springframework.hateoas
Value object to represent a list of Links.
links(Iterable<Link>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Adds the given Links to the RepresentationModel to be built.
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>, Function<String, UriComponentsBuilder>, Supplier<ConversionService>) - 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.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.
linkToCurrentMapping() - Static method in class org.springframework.hateoas.server.mvc.BasicLinkBuilder
Creates a new BasicLinkBuilder to link to the current servlet mapping.
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.
loadIfPresent(String) - Static method in class org.springframework.hateoas.support.ClassUtils
 
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.
LRDD_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.LRDD.

M

manyOf(String...) - Static method in interface org.springframework.hateoas.LinkRelation
Creates a new Iterable of LinkRelation for each of the given Strings.
map(Function<String, String>) - Method in interface org.springframework.hateoas.LinkRelation
Returns a new LinkRelation with its relation mapped by the given function, unless it is an IANA one.
map(Function<String, String>) - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
map(Iterable<?>) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper
Maps the given source elements as embedded values.
map(LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper
Maps the given HalLinkRelation using the underlying relation transformer.
map(Iterable<? extends T>) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
Maps the given Iterable of entities to either a CollectionModel or simple List of RepresentationModels.
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.
mapLink(LinkRelation, Function<Link, Link>) - Method in class org.springframework.hateoas.RepresentationModel
Replaces the link(s) with the given LinkRelation with the mapper applied to each of the links.
mapLinkIf(boolean, LinkRelation, Function<Link, Link>) - Method in class org.springframework.hateoas.RepresentationModel
Replaces the link(s) with the given LinkRelation with the mapper applied to each of the links if the given condition is true.
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 used to register internal media types through spring.factories.
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.
MEMENTO_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.MEMENTO.
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(Stream<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, Stream<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.
messageResolver() - Method in class org.springframework.hateoas.config.HateoasConfiguration
 
MessageResolver - Interface in org.springframework.hateoas.mediatype
A simplified variant of MessageSourceAccessor to allow more direct replacement with a no-op implementation in case the target MessageSource is unavailable to avoid resolution overhead.
MessageSourceResolvableSerializer - Class in org.springframework.hateoas.mediatype
A Jackson serializer triggering message resolution via a MessageResolver for MessageSourceResolvable instances about to be serialized.
MessageSourceResolvableSerializer(MessageResolver) - Constructor for class org.springframework.hateoas.mediatype.MessageSourceResolvableSerializer
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.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, 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.
MONITOR_GROUP_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.MONITOR_GROUP.
MONITOR_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.MONITOR.
MONTH - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
MONTH_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
MvcLink - Class in org.springframework.hateoas.server.mvc
Syntactic sugar to create Link instances from MvcUriComponentsBuilder invocations.
MvcLink() - Constructor for class org.springframework.hateoas.server.mvc.MvcLink
 

N

name(String) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
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.
NEXT_ARCHIVE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.NEXT_ARCHIVE.
NEXT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.NEXT.
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.
NOFOLLOW_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.NOFOLLOW.
NONE - Static variable in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
 
NONE - Static variable in interface org.springframework.hateoas.AffordanceModel.PayloadMetadata
 
NONE - Static variable in class org.springframework.hateoas.Links
 
NONE - Static variable in interface org.springframework.hateoas.mediatype.hal.CurieProvider
 
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.
NOREFERRER_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.NOREFERRER.
NUMBER - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
NUMBER_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 

O

of(Iterable<T>) - Static method in class org.springframework.hateoas.CollectionModel
Creates a CollectionModel instance with the given content.
of(Iterable<T>, Link...) - Static method in class org.springframework.hateoas.CollectionModel
Creates a CollectionModel instance with the given content and Links (optional).
of(Iterable<T>, Iterable<Link>) - Static method in class org.springframework.hateoas.CollectionModel
s Creates a CollectionModel instance with the given content and Links.
of(ObjectMapper, List<HypermediaMappingInformation>) - Static method in class org.springframework.hateoas.config.WebConverters
Creates a new WebConverters from the given ObjectMapper and HypermediaMappingInformations.
of(T) - Static method in class org.springframework.hateoas.EntityModel
Creates a new EntityModel with the given content.
of(T, Link...) - Static method in class org.springframework.hateoas.EntityModel
Creates a new EntityModel with the given content and Links (optional).
of(T, Iterable<Link>) - Static method in class org.springframework.hateoas.EntityModel
Creates a new EntityModel with the given content and Links.
of(String) - Static method in class org.springframework.hateoas.Link
Creates a new link to the given URI with the self relation.
of(String, String) - Static method in class org.springframework.hateoas.Link
Creates a new Link to the given href with the given relation.
of(String, LinkRelation) - Static method in class org.springframework.hateoas.Link
Creates a new Link to the given href and LinkRelation.
of(UriTemplate, String) - Static method in class org.springframework.hateoas.Link
Creates a new Link to the given UriTemplate and link relation.
of(UriTemplate, LinkRelation) - Static method in class org.springframework.hateoas.Link
Creates a new Link to the given UriTemplate and LinkRelation.
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(Link) - Static method in class org.springframework.hateoas.mediatype.Affordances
 
of(String, Object) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue
Creates a new HalFormsPromptedValue with the given plain prompt and value.
of(LinkRelation) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
Returns a HalLinkRelation for the given general LinkRelation.
of(String) - Static method in class org.springframework.hateoas.mediatype.hal.LinkMixin
 
of(String) - Static method in class org.springframework.hateoas.mediatype.html.HtmlInputType
Returns the HtmlInputType for the given string value.
of(MessageSource) - Static method in interface org.springframework.hateoas.mediatype.MessageResolver
Obtains a MessageResolver for the given MessageSource.
of(Collection<T>, PagedModel.PageMetadata) - Static method in class org.springframework.hateoas.PagedModel
Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).
of(Collection<T>, PagedModel.PageMetadata, Link...) - Static method in class org.springframework.hateoas.PagedModel
Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).
of(Collection<T>, PagedModel.PageMetadata, Iterable<Link>) - Static method in class org.springframework.hateoas.PagedModel
Creates a new PagedModel from the given content PagedModel.PageMetadata and Links.
of(MethodParameter) - Static method in class org.springframework.hateoas.QueryParameter
Creates a new QueryParameter from the given MethodParameter.
of(T) - Static method in class org.springframework.hateoas.RepresentationModel
Creates a new RepresentationModel for the given content object and no links.
of(T, Iterable<Link>) - Static method in class org.springframework.hateoas.RepresentationModel
Creates a new RepresentationModel for the given content object and links.
of(MappingDiscoverer) - Static method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
 
of(Method) - Static method in class org.springframework.hateoas.server.core.MethodParameters
Returns the MethodParameters for the given Method.
of(Object) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
Creates a new Link from the given MvcUriComponentsBuilder invocation defaulting to the IanaLinkRelations.SELF link relation.
of(Supplier<Object>) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
Creates a new Link from the given lazy MvcUriComponentsBuilder invocation defaulting to the IanaLinkRelations.SELF link relation.
of(Object, LinkRelation) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
Creates a new Link from the given MvcUriComponentsBuilder invocation.
of(Supplier<Object>, LinkRelation) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
Creates a new Link from the given lazy MvcUriComponentsBuilder invocation.
of(String) - Static method in class org.springframework.hateoas.UriTemplate
Returns a UriTemplate for the given String template.
of(String, TemplateVariables) - Static method in class org.springframework.hateoas.UriTemplate
Returns a UriTemplate for the given String template.
ofI18ned(String, Object) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue
Creates a new HalFormsPromptedValue with the given prompt key to be used for i18nization and value.
on(Class<T>) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
Syntactic sugar for MvcUriComponentsBuilder.on(Class) to avoid the additional static import.
optional(String) - Static method in class org.springframework.hateoas.QueryParameter
Creates a new optional QueryParameter with the given name;
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
Spring container configuration support.
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
Value objects to build Collection+JSON representations.
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
HAL-FORMS extension media type.
org.springframework.hateoas.mediatype.html - package org.springframework.hateoas.mediatype.html
Support for HTML media type.
org.springframework.hateoas.mediatype.problem - package org.springframework.hateoas.mediatype.problem
Value objects to build Problem representations.
org.springframework.hateoas.mediatype.uber - package org.springframework.hateoas.mediatype.uber
UBER media type objects.
org.springframework.hateoas.mediatype.vnderrors - package org.springframework.hateoas.mediatype.vnderrors
Vnd.Error media type.
org.springframework.hateoas.server - package org.springframework.hateoas.server
Server-side components for hypermedia handling.
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
Spring WebFlux components to build Links and assemble RepresentationModel types.
org.springframework.hateoas.support - package org.springframework.hateoas.support
Support utilities for hypermedia handling.
ORIGINAL - Static variable in class org.springframework.hateoas.IanaLinkRelations
The Target IRI points to an Original Resource.
ORIGINAL_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.ORIGINAL.

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
Deprecated.
PagedModel(Collection<T>, PagedModel.PageMetadata, Iterable<Link>) - Constructor for class org.springframework.hateoas.PagedModel
Deprecated.
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 RFC-8288-compatible link format.
PASSWORD - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
PASSWORD_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
pathVariable(String) - Static method in class org.springframework.hateoas.TemplateVariable
Static helper to fashion TemplateVariable.VariableType.PATH_VARIABLE variables.
PAYMENT - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates a resource where payment is accepted.
PAYMENT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PAYMENT.
PINGBACK - Static variable in class org.springframework.hateoas.IanaLinkRelations
Gives the address of the pingback resource for the link context.
PINGBACK_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PINGBACK.
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.
PRECONNECT_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PRECONNECT.
PREDECESSOR_VERSION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a resource containing the predecessor version in the version history.
PREDECESSOR_VERSION_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
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.
PREFETCH_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PREFETCH.
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.
PRELOAD_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PRELOAD.
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.
PRERENDER_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PRERENDER.
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.
PREV_ARCHIVE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PREV_ARCHIVE.
PREV_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PREV.
PREVIEW - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource that provides a preview of the link's context.
preview(Object) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Initiates the setup of a preview given the current payload.
preview(Collection<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Starts a preview setup for the given Collection as preview.
preview(Collection<?>, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
Starts a preview setup for the given Collection as preview falling back to the given type if the Collection is empty.
PREVIEW_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PREVIEW.
PREVIOUS - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to the previous resource in an ordered series of resources.
PREVIOUS_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PREVIOUS.
PRIVACY_POLICY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a privacy policy associated with the link's context.
PRIVACY_POLICY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PRIVACY_POLICY.
Problem - Class in org.springframework.hateoas.mediatype.problem
Encapsulation of an RFC-7807 Problem code.
Problem(URI, String, int, String, URI) - Constructor for class org.springframework.hateoas.mediatype.problem.Problem
 
Problem() - Constructor for class org.springframework.hateoas.mediatype.problem.Problem
 
Problem.ExtendedProblem<T> - Class in org.springframework.hateoas.mediatype.problem
 
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.
PROFILE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.PROFILE.
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 (https://example.com?

R

RADIO - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
RADIO_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
RANGE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
RANGE_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
ReactiveRepresentationModelAssembler<T,D extends RepresentationModel<D>> - Interface in org.springframework.hateoas.server.reactive
registerHypermediaTypes(RestTemplate) - Method in class org.springframework.hateoas.config.HypermediaRestTemplateConfigurer
Insert hypermedia-aware message converters in front of any other existing message converters.
registerHypermediaTypes(WebClient.Builder) - Method in class org.springframework.hateoas.config.HypermediaWebClientConfigurer
Apply the proper Jackson2JsonEncoders and Jackson2JsonDecoders to this WebClient.Builder.
registerHypermediaTypes(WebClient) - Method in class org.springframework.hateoas.config.WebClientConfigurer
Deprecated.
Register the proper ExchangeStrategies for a given WebClient.
registerInstance(Object) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
 
registerPattern(Class<?>, String) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Deprecated.
prefer HalFormsConfiguration.withPattern(Class, String) that returns a fresh instance, to be removed with 1.3.
rel(String) - Static method in class org.springframework.hateoas.client.Hop
Creates a new Hop for the given relation name.
REL_ABOUT - Static variable in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
REL_DESCRIBES - Static variable in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
REL_FIRST - Static variable in class org.springframework.hateoas.Link
Deprecated.
REL_HELP - Static variable in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
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.
RELATED_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.RELATED.
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.
remote(Link) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
Creates a new HalFormsOptions.Remote options representation using the given Link.
remote(String) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
Creates a new HalFormsOptions.Remote options representation using the given href.
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.
REPLIES_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.REPLIES.
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(Iterable<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<?>> - 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(HandlerMethodReturnValueHandler, Supplier<RepresentationModelProcessorInvoker>) - 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.CollectionModelProcessorWrapper - Class in org.springframework.hateoas.server.mvc
ProcessorWrapper for RepresentationModelProcessors targeting CollectionModel.
requestParameter(String) - Static method in class org.springframework.hateoas.TemplateVariable
Static helper to fashion TemplateVariable.VariableType.REQUEST_PARAM variables.
requestParameterContinued(String) - Static method in class org.springframework.hateoas.TemplateVariable
Static helper to fashion TemplateVariable.VariableType.REQUEST_PARAM_CONTINUED variables.
required(String) - Static method in class org.springframework.hateoas.QueryParameter
Creates a new required QueryParameter with the given name;
resolve(MessageSourceResolvable) - Method in interface org.springframework.hateoas.mediatype.MessageResolver
Resolve the given MessageSourceResolvable.
RESTCONF - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies the root of RESTCONF API as configured on this HTTP server.
RESTCONF_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.RESTCONF.
rt(String) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 

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.
SEARCH - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
SEARCH_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.SEARCH.
SEARCH_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
SECTION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a section in a collection of resources.
SECTION_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.SECTION.
segment(String) - Static method in class org.springframework.hateoas.TemplateVariable
Static helper to fashion TemplateVariable.VariableType.SEGMENT variables.
SELF - Static variable in class org.springframework.hateoas.IanaLinkRelations
Conveys an identifier for the link's context.
SELF_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.SELF.
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
 
serialize(MessageSourceResolvable, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.mediatype.MessageSourceResolvableSerializer
 
serializerInstance(SerializationConfig, Annotated, Class<?>) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
 
SERVICE - Static variable in class org.springframework.hateoas.IanaLinkRelations
Indicates a URI that can be used to retrieve a service document.
SERVICE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.SERVICE.
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.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.
slash(String) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
Creates a new WebFluxLinkBuilder.WebFluxBuilder appending the given path to the currently to be built link.
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.
START_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.START.
statusOnly(HttpStatus) - Static method in class org.springframework.hateoas.mediatype.problem.Problem
Returns a Problem instance with the given HttpStatus and defaults as defined in RFC7807.
stream() - Method in interface org.springframework.hateoas.AffordanceModel.PayloadMetadata
Returns all properties contained in a payload.
stream() - Method in class org.springframework.hateoas.Links
Creates a Stream of the current Links.
stream() - Method in class org.springframework.hateoas.mediatype.Affordances
Returns all Affordances created.
STYLESHEET - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a stylesheet.
STYLESHEET_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.STYLESHEET.
SUBSECTION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Refers to a resource serving as a subsection in a collection of resources.
SUBSECTION_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.SUBSECTION.
SUCCESSOR_VERSION - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a resource containing the successor version in the version history.
SUCCESSOR_VERSION_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.SUCCESSOR_VERSION.
supports(MediaType) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
 
supports(MediaType) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
 
supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
 
supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.hateoas.server.core.DefaultLinkRelationProvider
 
supports(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
 
supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.hateoas.server.core.DelegatingLinkRelationProvider
 
supports(LinkRelationProvider.LookupContext) - Method in interface org.springframework.hateoas.server.LinkRelationProvider
Callback method to manually select LinkRelationProvider implementations based on a given LinkRelationProvider.LookupContext.
supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider
 
supports(ResolvableType, Object) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.CollectionModelProcessorWrapper
 
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.
TAG_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.TAG.
TEL - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
TEL_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
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(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.
TERMS_OF_SERVICE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.TERMS_OF_SERVICE.
TEXT - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
TEXT_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
TEXTAREA - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
TEXTAREA_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
TIME - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
TIME_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
TIMEGATE - Static variable in class org.springframework.hateoas.IanaLinkRelations
The Target IRI points to a TimeGate for an Original Resource.
TIMEGATE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.TIMEGATE.
TIMEMAP - Static variable in class org.springframework.hateoas.IanaLinkRelations
The Target IRI points to a TimeMap for an Original Resource.
TIMEMAP_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.TIMEMAP.
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() - Method in interface org.springframework.hateoas.mediatype.AffordanceOperations
Returns a Link equipped with the Affordance currently under construction.
toLink() - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
toLink() - Method in class org.springframework.hateoas.mediatype.Affordances
 
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.Affordance
 
toString() - Method in class org.springframework.hateoas.client.Hop
 
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 class org.springframework.hateoas.mediatype.alps.Alps.AlpsBuilder
 
toString() - Method in class org.springframework.hateoas.mediatype.alps.Alps
 
toString() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
toString() - Method in class org.springframework.hateoas.mediatype.alps.Descriptor
 
toString() - Method in class org.springframework.hateoas.mediatype.alps.Doc.DocBuilder
 
toString() - Method in class org.springframework.hateoas.mediatype.alps.Doc
 
toString() - Method in class org.springframework.hateoas.mediatype.alps.Ext.ExtBuilder
 
toString() - Method in class org.springframework.hateoas.mediatype.alps.Ext
 
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.html.HtmlInputType
 
toString() - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
toString() - Method in class org.springframework.hateoas.mediatype.problem.Problem
 
toString() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
toString() - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
 
toString() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
 
toString() - Method in class org.springframework.hateoas.PagedModel
 
toString() - Method in class org.springframework.hateoas.QueryParameter
 
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.server.LinkRelationProvider.LookupContext
 
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.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(Type) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
 
Type - Enum in org.springframework.hateoas.mediatype.alps
An enum for ALPS descriptor types
TYPE_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.TYPE.
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.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.ConfigurableHandlerInstantiator
 
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.ConfigurableHandlerInstantiator
 

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.
UP_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.UP.
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.
UriTemplateFactory - Class in org.springframework.hateoas.server.core
Builds and caches UriTemplate instances.
UriTemplateFactory() - Constructor for class org.springframework.hateoas.server.core.UriTemplateFactory
 
URL - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
URL_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 

V

value() - Method in interface org.springframework.hateoas.LinkRelation
Return the link relation's value.
value(String) - Method in class org.springframework.hateoas.mediatype.alps.Doc.DocBuilder
 
value(String) - Method in class org.springframework.hateoas.mediatype.alps.Ext.ExtBuilder
 
value() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
 
value() - Method in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
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-8288 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(String) - Method in class org.springframework.hateoas.mediatype.alps.Alps.AlpsBuilder
 
VERSION_HISTORY - Static variable in class org.springframework.hateoas.IanaLinkRelations
Points to a resource containing the version history for the context.
VERSION_HISTORY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.VERSION_HISTORY.
VIA - Static variable in class org.springframework.hateoas.IanaLinkRelations
Identifies a resource that is the source of the information in the link's context.
VIA_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.VIA.
virtualPropertyWriterInstance(MapperConfig<?>, Class<?>) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
 
VND_ERROR_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/vnd.error+json.
VND_ERROR_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.VND_ERROR_JSON.
VndError(String, String, Object, List<Link>) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
Creates a new VndErrors.VndError with a message and optional a path and a logref.
VndError(String, String, Object, Link...) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
 
VndError(String, String, Link...) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors.VndError
Deprecated.
Use VndError(String, String, Object, Link...) (with proper ordering of arguments)
VndErrors - Class in org.springframework.hateoas.mediatype.vnderrors
Deprecated.
since 1.1, use Problem to form vendor neutral error messages.
VndErrors() - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
VndErrors(Object, String, Link...) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
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
Deprecated.
Creates a new VndErrors wrapper for at least one VndErrors.VndError.
VndErrors(List<VndErrors.VndError>, String, Object, Links) - Constructor for class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
Creates a new VndErrors wrapper for the given VndErrors.
VndErrors.VndError - Class in org.springframework.hateoas.mediatype.vnderrors
Deprecated.
Use Problem to form vendor neutral error messages.

W

WebClientConfigurer - Class in org.springframework.hateoas.config
Deprecated.
Migrate to HypermediaWebClientConfigurer and it's WebClient.Builder-oriented approach.
WebClientConfigurer(ObjectMapper, List<HypermediaMappingInformation>) - Constructor for class org.springframework.hateoas.config.WebClientConfigurer
Deprecated.
Creates a new WebClientConfigurer for the given ObjectMapper and HypermediaMappingInformations.
WebConverters - Class in org.springframework.hateoas.config
Value type to handle registration of hypermedia related HttpMessageConverters.
WebFluxBuilder(Mono<WebFluxLinkBuilder>) - Constructor for class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
 
WebFluxLink(Mono<Link>) - 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
 
WebHandler.PreparedWebHandler<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.
WEBMENTION_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.WEBMENTION.
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.
WEEK - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
WEEK_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
 
with(String, String, Long, Long, Object) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
with(String, String, Long, Long, Object) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.Inline
 
with(String, String, Long, Long, Object) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.Remote
 
with(PropertyNamingStrategy) - Method in class org.springframework.hateoas.mediatype.hal.Jackson2HalModule.EmbeddedMapper
Registers the given PropertyNamingStrategy with the current mapper to forward that strategy as relation transformer, so that LinkRelations used as key for the embedding will be transformed using the given strategy.
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.
withApplyPropertyNamingStrategy(boolean) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
Create a new HalConfiguration by copying the attributes and replacing the applyProperNamingStrategy.
withDeprecation(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new deprecation.
withDetail(String) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
withDetail(String) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Create a new Problem by copying its attributes and replacing the detail.
withEnforceEmbeddedCollections(boolean) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
Create a new HalConfiguration by copying the attributes and replacing the enforceEmbeddedCollections.
withError(VndErrors.VndError) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
withErrors(List<VndErrors.VndError>) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
withHeaders(HttpHeaders) - Method in class org.springframework.hateoas.client.Hop
Create a new Hop by copying all the attributes and replacing the headers.
withHeaders(HttpHeaders) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
The HttpHeaders that shall be used for the requests of the traversal.
withHref(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new href.
withHreflang(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new hrefleng.
withInput(Class<?>) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInput(ResolvableType) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInput(AffordanceModel.PayloadMetadata) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInput(Class<?>) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given type as input model for the affordance.
withInput(ResolvableType) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given ResolvableType as input model for the affordance.
withInput(AffordanceModel.PayloadMetadata) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given AffordanceModel.PayloadMetadata as input model.
withInputAndOutput(Class<?>) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInputAndOutput(ResolvableType) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInputAndOutput(AffordanceModel.PayloadMetadata) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInputAndOutput(Class<?>) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given type as input and output model for the affordance.
withInputAndOutput(ResolvableType) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given ResolvableType as input and output model for the affordance.
withInputAndOutput(AffordanceModel.PayloadMetadata) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given AffordanceModel.PayloadMetadata as input and output model.
withInputMediaType(MediaType) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInputMediaType(MediaType) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the input to expect to be of the given MediaType.
withInputMediaTypes(List<MediaType>) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withInputMediaTypes(List<MediaType>) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given MediaTypes as input payload media types.
withInstance(URI) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
withInstance(URI) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Create a new Problem by copying its attributes and replacing the instance.
withLink(Link) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
withLinks(Link...) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
withLogref(Integer) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
withMaxItems(Long) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
Configures the maximum number of items to be selected.
withMedia(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new media.
withMediaType(MediaType) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
Registers additional media types that are supposed to be aliases to MediaTypes.HAL_JSON.
withMediaTypes(List<MediaType>) - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
Creates a new AffordanceModel.InputPayloadMetadata with the given MediaType assigned.
withMessage(String) - Method in class org.springframework.hateoas.mediatype.vnderrors.VndErrors
Deprecated.
 
withMinItems(Long) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
Configures the minimum number of items to be selected.
withName(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new name.
withName(String) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withName(String) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Create a new Affordances.AffordanceBuilder by copying all attributes and replacing the name.
withObjectMapperCustomizer(Consumer<ObjectMapper>) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Register the given Consumer to apply additional customizations on the ObjectMapper used to render HAL documents.
withObjectMapperCustomizer(Consumer<ObjectMapper>) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
Configures an ObjectMapper customizer to tweak the instance after it has been pre-configured with all HAL specific setup.
withOptions(Class<T>, String, Function<AffordanceModel.PropertyMetadata, HalFormsOptions>) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Returns a new HalFormsConfiguration with the given
without(LinkRelation) - Method in class org.springframework.hateoas.Links
Returns a Links with all Links with the given LinkRelation removed.
withOutput(Class<?>) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withOutput(ResolvableType) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withOutput(AffordanceModel.PayloadMetadata) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withOutput(Class<?>) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given type as the output model.
withOutput(ResolvableType) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given ResolvableType as the output model.
withOutput(AffordanceModel.PayloadMetadata) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Registers the given AffordanceModel.PayloadMetadata as output model.
withParameter(String, Object) - Method in class org.springframework.hateoas.client.Hop
Add one parameter to the map of parameters.
withParameters(Map<String, Object>) - Method in class org.springframework.hateoas.client.Hop
Create a new Hop by copying all the attributes and replacing the parameters.
withParameters(QueryParameter...) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withParameters(List<QueryParameter>) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withParameters(QueryParameter...) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Replaces the current QueryParameter list with the given ones.
withParameters(List<QueryParameter>) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Replaces the current QueryParameter list with the given ones.
withPattern(Class<?>, String) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
Registers a regular expression pattern to be used for form descriptions of the given type.
withProfile(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new profile.
withPromptField(String) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
Configures the given field to be used as prompt field.
withProperties(S) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
withProperties(T) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Creates a new Problem.ExtendedProblem with the given payload as additional properties.
withProperties(Consumer<Map<String, Object>>) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Returns an Problem.ExtendedProblem with a Map populated by the given consumer as payload.
withProperties(Map<String, Object>) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Returns an Problem.ExtendedProblem with the given Map unwrapping as additional properties.
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.
withRenderSingleLinks(HalConfiguration.RenderSingleLinks) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
Create a new HalConfiguration by copying the attributes and replacing the renderSingleLinks.
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 https://api.acme.com/foo/**).
withSelectedValue(Object) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
Configured the value to be initially selected
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
withStatus(HttpStatus) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
withStatus(HttpStatus) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Create a new Problem by copying its attributes and replacing the status.
withTarget(Link) - Method in class org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder
Deprecated.
 
withTarget(Link) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
Create a new Affordances.AffordanceBuilder by copying all attributes and replacing the target.
withTemplateParameters(Map<String, Object>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Adds the given operations parameters to the traversal.
withTitle(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new title.
withTitle(String) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
withTitle(String) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Create a new Problem by copying its attributes and replacing the title.
withType(String) - Method in class org.springframework.hateoas.Link
Create a new Link by copying all attributes and applying the new type.
withType(URI) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
 
withType(URI) - Method in class org.springframework.hateoas.mediatype.problem.Problem
Create a new Problem by copying its attributes and replacing the type.
withValue(String) - Method in class org.springframework.hateoas.QueryParameter
Create a new QueryParameter by copying all attributes and applying the new value.
withValueField(String) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions
Configures the given field to be used as value field.
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.
WORKING_COPY_OF_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.WORKING_COPY_OF.
WORKING_COPY_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
A String equivalent of IanaLinkRelations.WORKING_COPY.
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 © 2011–2021 Pivotal, Inc.. All rights reserved.