Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
$
- $$() - Constructor for class org.springframework.hateoas.server.core.TypeReferences.$$
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
EntityLinksby 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.HalJacksonModule.TrueOnlyBooleanSerializer
- 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 the given link 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
Linkproduced by the given Supplier if the guard is true. - addLinks(CollectionModel<EntityModel<T>>) - Method in interface org.springframework.hateoas.server.SimpleRepresentationModelAssembler
-
Define links to add to the
CollectionModelcollection. - addLinks(CollectionModel<EntityModel<T>>, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.SimpleReactiveRepresentationModelAssembler
-
Define links to add to the
CollectionModelcollection. - addLinks(EntityModel<T>) - Method in interface org.springframework.hateoas.server.SimpleRepresentationModelAssembler
-
Define links to add to every individual
EntityModel. - addLinks(EntityModel<T>, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.SimpleReactiveRepresentationModelAssembler
-
Define links to add to every individual
EntityModel. - addParameters(QueryParameter...) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Adds the given
QueryParameters to theAffordanceto build. - afford(Object) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
- afford(HttpMethod) - Method in class org.springframework.hateoas.mediatype.Affordances
-
Creates a new
Affordances.AffordanceBuilderfor the given HTTP method for further customization. - 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.PropertyMetadataapplied. - AffordanceModelFactory - Interface in org.springframework.hateoas.mediatype
-
SPI for media type implementations to create a specific
AffordanceModelfor aConfiguredAffordance. - AffordanceOperations - Interface in org.springframework.hateoas.mediatype
-
Operations commons to all builder APIs.
- Affordances - Class in org.springframework.hateoas.mediatype
-
Primary API to construct
Affordanceinstances. - afterConfigurerAdded(WebTestClient.Builder, WebHttpHandlerBuilder, ClientHttpConnector) - Method in class org.springframework.hateoas.config.HypermediaWebTestClientConfigurer
-
Register the proper
Jackson2JsonEncoders andAbstractJacksonDecoders for a givenWebTestClient. - afterPropertiesSet() - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
- alps() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
-
Returns a new
Alps.AlpsBuilder. - Alps - Class in org.springframework.hateoas.mediatype.alps
-
An ALPS document.
- 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. - Alps.AlpsBuilder - Class in org.springframework.hateoas.mediatype.alps
- AlpsLinkDiscoverer - Class in org.springframework.hateoas.mediatype.alps
-
LinkDiscovererimplementation 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(Iterable<Link>) - Method in class org.springframework.hateoas.Links
- and(Stream<Link>) - Method in class org.springframework.hateoas.Links
- and(Link...) - Method in class org.springframework.hateoas.Links
- andAfford(HttpMethod) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Concludes the creation of the current
Affordanceto build and starts a new one. - andAffordance(Object) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
-
Adds the affordance created by the given virtual method invocation.
- andAffordance(Affordance) - Method in class org.springframework.hateoas.Link
-
Create new
Linkwith an additionalAffordance. - andAffordances(List<Affordance>) - Method in class org.springframework.hateoas.Link
-
Create new
Linkwith additionalAffordances. - 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.
- andIf(boolean, 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
- AnnotationAttribute(Class<? extends Annotation>, String) - Constructor for class org.springframework.hateoas.server.core.AnnotationAttribute
-
Creates a new
AnnotationAttributefor the givenAnnotationtype and annotation attribute name. - AnnotationLinkRelationProvider - Class in org.springframework.hateoas.server.core
-
LinkRelationProviderthat evaluates theRelationannotation on entity types. - AnnotationLinkRelationProvider() - Constructor for class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
- AnnotationMappingDiscoverer - Class in org.springframework.hateoas.server.core
-
MappingDiscovererimplementation that inspects mappings from a particular annotation. - AnnotationMappingDiscoverer(Class<? extends Annotation>) - Constructor for class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
-
Creates an
AnnotationMappingDiscovererfor the given annotation type. - AnnotationMappingDiscoverer(Class<? extends Annotation>, String) - Constructor for class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
-
Creates an
AnnotationMappingDiscovererfor 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
-
Applies the given
AffordanceModel.PropertyMetadata. - 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. - AS_ARRAY - Enum constant in enum class org.springframework.hateoas.mediatype.hal.HalConfiguration.RenderSingleLinks
-
A single
Linkis rendered as a JSON Array. - AS_SINGLE - Enum constant in enum class org.springframework.hateoas.mediatype.hal.HalConfiguration.RenderSingleLinks
-
A single
Linkis rendered as a JSON object. - ASCIIDOC - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Format
- asLink() - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
-
Returns the
Linkfound for the last rel in the rels configured to follow. - asList() - Method in class org.springframework.hateoas.TemplateVariables
-
Returns the contained
TemplateVariables asList. - asString() - Method in class org.springframework.hateoas.TemplateVariable
- asTemplatedLink() - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
-
Returns the templated
Linkfound 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
ListofHttpMessageConverters 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
LinkBuilderimplementation 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.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
Affordancecurrently under construction and returns in alongside the ones already contained in theLinkthe buildup started from. - build() - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Transform the entities and
Links into aRepresentationModel. - 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. - 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.TypeConstrainedJacksonJsonHttpMessageConverter
- canRead(ResolvableType, MediaType) - Method in class org.springframework.hateoas.server.mvc.TypeConstrainedJacksonJsonHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.hateoas.server.mvc.TypeConstrainedJacksonJsonHttpMessageConverter
- 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 - Enum constant in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
-
Collection+JSON
- 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. - CollectionJsonJacksonModule - Class in org.springframework.hateoas.mediatype.collectionjson
-
Jackson 2 module implementation to render
CollectionModel,EntityModel, andRepresentationModelinstances in Collection+JSON compatible JSON. - CollectionJsonJacksonModule() - Constructor for class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonJacksonModule
- CollectionJsonLinkDiscoverer - Class in org.springframework.hateoas.mediatype.collectionjson
-
LinkDiscovererimplementation 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
CollectionModelinstance. - CollectionModel(Iterable<T>) - Constructor for class org.springframework.hateoas.CollectionModel
- CollectionModel(Iterable<T>, Iterable<Link>, ResolvableType) - Constructor for class org.springframework.hateoas.CollectionModel
- 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
-
Creates a new
RepresentationModelProcessorInvoker.CollectionModelProcessorWrapperfor the givenRepresentationModelProcessor. - CollectionModelType() - Constructor for class org.springframework.hateoas.server.core.TypeReferences.CollectionModelType
- collectionRelation() - Element in annotation interface org.springframework.hateoas.server.core.Relation
-
Defines the relation to be used when referring to a collection of resources.
- collector() - Static method in class org.springframework.hateoas.Links
- COLOR - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
- COLOR_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
- composite() - Method in class org.springframework.hateoas.TemplateVariable
-
Marks the current template variable as composite value.
- COMPOSITE - Enum constant in enum class org.springframework.hateoas.TemplateVariable.Cardinality
- concat(Collection<TemplateVariable>) - Method in class org.springframework.hateoas.TemplateVariables
-
Concatenates the given
TemplateVariables to the current one. - concat(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
TemplateVariablesto the current one. - conclude(Function<UriMapping, 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
HandlerInstantiatorthat will use instances explicitly registered with it but fall back to lookup or even create a fresh instance via theAutowireCapableBeanFactoryprovided on construction. - ConfigurableHandlerInstantiator(AutowireCapableBeanFactory) - Constructor for class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
-
Creates a new
ConfigurableHandlerInstantiatorfor the givenAutowireCapableBeanFactory. - ConfiguredAffordance - Interface in org.springframework.hateoas.mediatype
-
A configure affordance for inspection by media type implementations to create
AffordanceModelinstances. - configureJsonMapper(JsonMapper.Builder) - Method in interface org.springframework.hateoas.config.HypermediaMappingInformation
-
Configure an
JsonMapper.Builderand register custom serializers and deserializers for the supported media types. - configureJsonMapper(JsonMapper.Builder) - Method in class org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration
- contains(Iterable<Link>) - Method in class org.springframework.hateoas.Links
- contains(Link...) - Method in class org.springframework.hateoas.Links
- containsSameLinksAs(Iterable<Link>) - Method in class org.springframework.hateoas.Links
- 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
-
EntityLinksimplementation which assumes a certain URI mapping structure: A class-levelExposesResourceForannotation to declare that the annotated controller exposes collection and item resources for. AnRequestMappingannotation to form the base URI of the collection resource. A controller method with a mapping annotation to actually handle at least one HTTP method. A controller method that maps a subordinate resource taking a path variable to identify an item resource. - ControllerEntityLinks(Iterable<? extends Class<?>>, LinkBuilderFactory<? extends LinkBuilder>) - Constructor for class org.springframework.hateoas.server.core.ControllerEntityLinks
-
Creates a new
ControllerEntityLinksinspecting the configured classes for the given annotation. - ControllerEntityLinksFactoryBean - Class in org.springframework.hateoas.server.core
-
FactoryBeanimplementation to createControllerEntityLinksinstances looking up controller classes from anApplicationContext. - ControllerEntityLinksFactoryBean() - Constructor for class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
- ControllerLinkRelationProvider - Class in org.springframework.hateoas.server.mvc
-
LinkRelationProviderinspectingExposesResourceForannotations on controller classes. - ControllerLinkRelationProvider(Class<?>, PluginRegistry<LinkRelationProvider, LinkRelationProvider.LookupContext>) - Constructor for class org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider
-
Creates a new
ControllerLinkRelationProvider - ControllerMethodReturnTypeAotProcessor - Class in org.springframework.hateoas.aot
-
A
BeanRegistrationAotProcessorthat contributes proxy types for return types of controller methods so that can be pointed to byDummyInvocationUtils, i.e. creating links via fake method invocations. - ControllerMethodReturnTypeAotProcessor() - Constructor for class org.springframework.hateoas.aot.ControllerMethodReturnTypeAotProcessor
-
Creates a new
ControllerMethodReturnTypeAotProcessorlooking for classes annotated withController. - ControllerMethodReturnTypeAotProcessor(Class<? extends Annotation>) - Constructor for class org.springframework.hateoas.aot.ControllerMethodReturnTypeAotProcessor
-
Creates a new
ControllerMethodReturnTypeAotProcessorlooking for classes equipped with the given annotation. - 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
Probleminstance. - create(T) - Static method in class org.springframework.hateoas.mediatype.problem.Problem
-
Returns an
Problem.ExtendedProblemwith 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. - createArray() - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- createBuilder(UriComponents, TemplateVariables, List<Affordance>) - Method in interface org.springframework.hateoas.server.core.WebHandler.LinkBuilderCreator
- createContextual(DeserializationContext, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesDeserializer
- createContextual(SerializationContext, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- createContextual(SerializationContext, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- createContextual(SerializationContext, BeanProperty) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.OptionalListJackson2Serializer
- createInstance() - Method in class org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean
- createMap() - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- 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>) - Method in class org.springframework.hateoas.server.mvc.BasicLinkBuilder
- createNewInstance(UriComponents, List<Affordance>, TemplateVariables) - Method in class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport
- 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
Listof properties based on the given creator. - curie(String) - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
-
Creates a new
HalLinkRelationcuried to the given value. - Curie(String, String) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider.Curie
- curieBuilder(String) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
-
Creates a new
HalLinkRelation.HalLinkRelationBuilderfor the given curie. - curied(String, String) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
-
Creates a new
HalLinkRelationfor a curied relation. - curieIfUncuried(String) - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
-
Returns a curied
HalLinkRelationeither 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) - Method in interface org.springframework.hateoas.mediatype.MediaTypeConfigurationCustomizer
-
Customize the given configuration instance.
- customize(JsonMapper.Builder) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
-
Customizes the given
JsonMapperwith the registered callback. - customize(JsonMapper.Builder) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
- customize(T, Function<AffordanceModel.PropertyMetadata, T>) - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
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
CurieProviderrendering a single configurableUriTemplatebased curie. - DefaultCurieProvider(String, UriTemplate) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
-
Creates a new
DefaultCurieProviderfor the given name andUriTemplate. - DefaultCurieProvider(Map<String, UriTemplate>) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
-
Creates a new
DefaultCurieProviderfor the given curies. - DefaultCurieProvider(Map<String, UriTemplate>, String) - Constructor for class org.springframework.hateoas.mediatype.hal.DefaultCurieProvider
-
Creates a new
DefaultCurieProviderfor 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
Linkrendered in JSON. - DefaultLinkRelationProvider - Class in org.springframework.hateoas.server.core
-
Default implementation of
LinkRelationProviderto simply use the uncapitalized version of the given type's name as item resourceLinkRelationas well as an appendedListfor the collection resourceLinkRelation. - 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
-
EntityLinksimplementation that delegates to theEntityLinksinstances registered in thePluginRegistrygiven on instance creation. - DelegatingEntityLinks(PluginRegistry<EntityLinks, Class<?>>) - Constructor for class org.springframework.hateoas.server.core.DelegatingEntityLinks
-
Creates a new
DelegatingEntityLinksusing the givenPluginRegistry. - DelegatingLinkRelationProvider - Class in org.springframework.hateoas.server.core
- DelegatingLinkRelationProvider(LinkRelationProvider...) - Constructor for class org.springframework.hateoas.server.core.DelegatingLinkRelationProvider
-
Creates a new
DefaultLinkRelationProviderfor the givenLinkRelationProviders. - 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() - Static method in class org.springframework.hateoas.mediatype.alps.Alps
-
Returns a new
Descriptor.DescriptorBuilder. - descriptor(List<Descriptor>) - Method in class org.springframework.hateoas.mediatype.alps.Alps.AlpsBuilder
- descriptor(List<Descriptor>) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
- Descriptor - Class in org.springframework.hateoas.mediatype.alps
-
A value object for an ALPS descriptor.
- Descriptor.DescriptorBuilder - Class in org.springframework.hateoas.mediatype.alps
- deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListDeserializer
- deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.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() - 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.Alps.AlpsBuilder
- 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
- Doc.DocBuilder - Class in org.springframework.hateoas.mediatype.alps
- DOT - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- 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) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Embeds the given entity into the
RepresentationModel. - embed(Object, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Embed the entity and associate it with the
LinkRelation. - 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
RepresentationModeland theLinkRelationderived from the given type. - embed(Collection<?>, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Embeds the given collection in the
RepresentationModelfor the givenLinkRelation. - embed(Stream<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Embeds the given
Streamin theRepresentationModel. - embed(Stream<?>, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Embeds the given
Streamin theRepresentationModeland theLinkRelationderived from the given type. - embed(Stream<?>, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
- EmbeddedMapper(LinkRelationProvider, CurieProvider, boolean) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.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() - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModel. - empty() - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModel. - empty(PagedModel.PageMetadata) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the givenPagedModel.PageMetadata. - empty(PagedModel.PageMetadata, Class<?>, Class<?>...) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the givenPagedModel.PageMetadataand fallback type. - empty(PagedModel.PageMetadata, Iterable<Link>) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the givenPagedModel.PageMetadataand links. - empty(PagedModel.PageMetadata, ParameterizedTypeReference<T>) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the givenPagedModel.PageMetadataand fallback type. - empty(PagedModel.PageMetadata, ResolvableType) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the givenPagedModel.PageMetadataand fallback type. - empty(PagedModel.PageMetadata, Link...) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the givenPagedModel.PageMetadataand links. - empty(SlicedModel.SliceMetadata) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the givenSlicedModel.SliceMetadata. - empty(SlicedModel.SliceMetadata, Class<?>, Class<?>...) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the givenSlicedModel.SliceMetadataand fallback type. - empty(SlicedModel.SliceMetadata, Iterable<Link>) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the givenSlicedModel.SliceMetadataand links. - empty(SlicedModel.SliceMetadata, ParameterizedTypeReference<T>) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the givenSlicedModel.SliceMetadataand fallback type. - empty(SlicedModel.SliceMetadata, ResolvableType) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the givenSlicedModel.SliceMetadataand fallback type. - empty(SlicedModel.SliceMetadata, Link...) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the givenSlicedModel.SliceMetadataand links. - empty(Class<T>, Class<?>) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the given fallback type. - empty(Class<T>, Class<?>) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the given fallback type. - empty(Class<T>, Class<?>...) - Static method in class org.springframework.hateoas.CollectionModel
-
Creates a new empty collection model with the given type defined as fallback type.
- empty(Iterable<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.PagedModel
-
Creates an empty
PagedModelwith the given links. - empty(Iterable<Link>) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the given links. - empty(ParameterizedTypeReference<T>) - Static method in class org.springframework.hateoas.CollectionModel
-
Creates a new empty collection model with the given type defined as fallback type.
- empty(ParameterizedTypeReference<T>) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the given fallback type. - empty(ParameterizedTypeReference<T>) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the given fallback type. - empty(ResolvableType) - Static method in class org.springframework.hateoas.CollectionModel
-
Creates a new empty collection model with the given type defined as fallback type.
- empty(ResolvableType) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the given fallback type. - empty(ResolvableType) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the given fallback type. - empty(Link...) - Static method in class org.springframework.hateoas.CollectionModel
-
Creates a new empty collection model with the given links.
- empty(Link...) - Static method in class org.springframework.hateoas.PagedModel
-
Creates an empty
PagedModelwith the given links. - empty(Link...) - Static method in class org.springframework.hateoas.SlicedModel
-
Creates an empty
SlicedModelwith the given links. - emptyCollectionOf(Class<?>) - Method in class org.springframework.hateoas.server.core.EmbeddedWrappers
-
Creates an
EmbeddedWrapperfor an emptyCollectionwith the given element type. - emptyHalModel() - Static method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Creates a new
HalModelBuilderwithout a primary payload. - EnableHypermediaSupport - Annotation Interface in org.springframework.hateoas.config
-
Activates hypermedia support in the
ApplicationContext. - EnableHypermediaSupport.HypermediaType - Enum Class 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. - encode(String) - Method in enum class org.springframework.hateoas.TemplateVariable.VariableType
- enhance(UriComponentsBuilder, MethodParameter, Object) - Method in interface org.springframework.hateoas.server.mvc.UriComponentsContributor
-
Enhance the given
UriComponentsBuilderwith 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
EntityModelwrapping a domain object and adding links to it. - EntityModel() - Constructor for class org.springframework.hateoas.EntityModel
-
Creates an empty
EntityModel. - EntityModel(T) - Constructor for class org.springframework.hateoas.EntityModel
- EntityModel(T, Iterable<Link>) - Constructor for class org.springframework.hateoas.EntityModel
-
Creates a new
EntityModelwith the given content andLinks. - 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.hal.HalLinkRelation
- 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.core.TypeReferences.$$
- equals(Object) - Method in class org.springframework.hateoas.server.core.UriMapping
- equals(Object) - Method in class org.springframework.hateoas.SlicedModel
- equals(Object) - Method in class org.springframework.hateoas.SlicedModel.SliceMetadata
- equals(Object) - Method in class org.springframework.hateoas.TemplateVariable
- equals(Object) - Method in class org.springframework.hateoas.TemplateVariables
- 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.problem.Problem
- equals(Object) - Method in class org.springframework.hateoas.mediatype.problem.Problem.ExtendedProblem
- equals(Object) - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
- EvoInflectorLinkRelationProvider - Class in org.springframework.hateoas.server.core
-
LinkRelationProviderimplementation 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
Linkby expanding it using the given parameters. - expand(Object...) - Method in class org.springframework.hateoas.UriTemplate
-
Expands the
UriTemplateusing the given parameters. - expand(Map<String, ?>) - Method in class org.springframework.hateoas.Link
-
Turns the current template into a
Linkby expanding it using the given parameters. - expand(Map<String, ?>) - Method in class org.springframework.hateoas.TemplateVariable
- expand(Map<String, ?>) - Method in class org.springframework.hateoas.UriTemplate
-
Expands the
UriTemplateusing the given parameters. - ExposesResourceFor - Annotation Interface 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
LinkDiscovererto extract relevant attributes and generate aLink. - 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(String, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Returns all links with the given link relation found in the given
InputStreamrepresentation. - findLinksWithRel(String, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Returns all links with the given link relation found in the given
Stringrepresentation. - findLinksWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
- findLinksWithRel(LinkRelation, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Returns all links with the given
LinkRelationfound in the givenInputStreamrepresentation. - findLinksWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
- findLinksWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
- findLinksWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
- findLinksWithRel(LinkRelation, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Returns all links with the given
LinkRelationfound in the givenStringrepresentation. - findLinksWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
- findLinksWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
- findLinkWithRel(String, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Finds a single link with the given relation type in the given
InputStreamrepresentation. - findLinkWithRel(String, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Finds a single link with the given relation type in the given
Stringrepresentation. - findLinkWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.client.JsonPathLinkDiscoverer
- findLinkWithRel(LinkRelation, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Finds a single link with the given
LinkRelationin the givenInputStreamrepresentation. - findLinkWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
- findLinkWithRel(LinkRelation, InputStream) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
- findLinkWithRel(LinkRelation, String) - 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
LinkRelationin the givenStringrepresentation. - findLinkWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.collectionjson.CollectionJsonLinkDiscoverer
- findLinkWithRel(LinkRelation, String) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
- findOrCreateInstance(Class<T>) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
- findRequiredLinkWithRel(LinkRelation, InputStream) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Finds a single link with the given relation type in the given
InputStreamrepresentation. - findRequiredLinkWithRel(LinkRelation, String) - Method in interface org.springframework.hateoas.client.LinkDiscoverer
-
Finds a single link with the given relation in the given
Stringrepresentation. - 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.TraversalBuilderto follow the given rels. - 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
-
Sets up a
Traverson.TraversalBuilderfor a single rel with customized details. - 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.LookupContextto lookup the collection resource relation for the given type. - forItemResourceRelLookup(Class<?>) - Static method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
-
Creates a
LinkRelationProvider.LookupContextto lookup the item resource relation for the given type. - forLink(String, LinkRelation) - Method in interface org.springframework.hateoas.mediatype.hal.HalModelBuilder.PreviewBuilder
-
Concludes the set up of a preview for the
Linkconsisting ot the given href andLinkRelation. - forLink(Link) - Method in interface org.springframework.hateoas.mediatype.hal.HalModelBuilder.PreviewBuilder
-
Concludes the set up of a preview for the given
Link. - format(Format) - Method in class org.springframework.hateoas.mediatype.alps.Doc.DocBuilder
- Format - Enum Class in org.springframework.hateoas.mediatype.alps
-
Enum for all ALPS doc formats.
- forType(Class<?>) - Static method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
-
Creates a
LinkRelationProvider.LookupContextfor the type in general, i.e. both item and collection relation lookups. - forType(Class<T>, Function<T, Object>) - Method in interface org.springframework.hateoas.server.EntityLinks
-
Creates a
TypedEntityLinksinstance using the given type and identifier extractor function. - forType(Function<T, ?>) - Method in interface org.springframework.hateoas.server.EntityLinks
-
Creates a
TypedEntityLinksinstance using the given identifier extractor function. - fragment(String) - Static method in class org.springframework.hateoas.TemplateVariable
-
Static helper to fashion
TemplateVariable.VariableType.FRAGMENTvariables. - FRAGMENT - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- from(Class<?>) - Static method in class org.springframework.hateoas.mediatype.html.HtmlInputType
-
Returns the
HtmlInputTypederived from the givenResolvableType. - from(String) - Static method in enum class org.springframework.hateoas.TemplateVariable.VariableType
-
Returns the
TemplateVariable.VariableTypefor the given variable key. - from(AffordanceModel.PayloadMetadata) - Static method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
G
- getAffordanceModel(ConfiguredAffordance) - Method in interface org.springframework.hateoas.mediatype.AffordanceModelFactory
-
Return the
AffordanceModelfor the givenConfiguredAffordance. - getAffordanceModel(MediaType) - Method in class org.springframework.hateoas.Affordance
-
Look up the
AffordanceModelfor the requestedMediaType. - 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 class 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.
- getConfiguration() - Method in class org.springframework.hateoas.mediatype.MediaTypeConfigurationFactory
-
Returns the customized configuration instance.
- getConsumes(Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
- 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
- getContentDeserializer() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListDeserializer
- getContentDeserializer() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesDeserializer
- getContentSerializer() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- getContentSerializer() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- getContentSerializer() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.OptionalListJackson2Serializer
- getContentType() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- getContentType() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- getContentType() - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.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.Curieinstance 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 givenMediaTypes 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.InputPayloadMetadatamodel for the givenResolvableType. - 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
HttpMessageConverterinstances to be registered for the givenMediaTypes. - 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 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
Moduleto be used to customize the serialization of representation models. - getLastInvocation() - Method in interface org.springframework.hateoas.server.core.LastInvocationAware
- getLastInvocationAware(Class<?>, Method, Object[]) - Static method in class org.springframework.hateoas.server.core.DummyInvocationUtils
-
Creates a simple
LastInvocationAwarefrom the given type, method and parameters. - getLastInvocationAware(Object) - Static method in class org.springframework.hateoas.server.core.DummyInvocationUtils
-
Returns the
LastInvocationAwareinstance from the given source, that essentially has to be a proxy created viaDummyInvocationUtils.methodOn(Class, Object...)and subsequentlinkTo(…)calls. - getLastInvocationAware(Method, Object[]) - Static method in class org.springframework.hateoas.server.core.DummyInvocationUtils
-
Creates a simple
LastInvocationAwarefor the given method and parameters. - getLink() - Method in class org.springframework.hateoas.AffordanceModel
- getLink() - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.Remote
-
Returns the
Linkpointing to the resource returning option values. - getLink(String) - Method in class org.springframework.hateoas.Links
-
Returns a
Linkwith the given relation if contained in the currentLinksinstance,Optional.empty()otherwise. - getLink(String) - Method in class org.springframework.hateoas.RepresentationModel
-
Returns the link with the given relation.
- getLink(LinkRelation) - Method in class org.springframework.hateoas.Links
-
Returns the
Linkwith the given rel. - getLink(LinkRelation) - Method in class org.springframework.hateoas.RepresentationModel
-
Returns the link with the given
LinkRelation. - getLinkDiscovererFor(String) - Method in class org.springframework.hateoas.client.LinkDiscoverers
-
Returns the
LinkDiscoverersuitable for the given media type. - getLinkDiscovererFor(MediaType) - Method in class org.springframework.hateoas.client.LinkDiscoverers
-
Returns the
LinkDiscoverersuitable for the givenMediaType. - getLinkDiscoverers(Collection<MediaType>) - Method in interface org.springframework.hateoas.client.TraversonDefaults
-
Returns the
LinkDiscoverers to be registered by default for the givenMediaTypes. - 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. - getLocalPackageName() - Method in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
- getLocalPart() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
- getMapper() - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- getMapping() - Method in class org.springframework.hateoas.server.core.UriMapping
-
Returns the raw mapping.
- getMapping(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
- 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
MediaTypethis factory supports. - getMediaTypes() - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
-
Returns the
MediaTypethat the payload requires. - getMediaTypes() - Method in enum class 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
- getMetadata() - Method in class org.springframework.hateoas.PagedModel
-
Returns the pagination metadata.
- getMetadata() - Method in class org.springframework.hateoas.SlicedModel
-
Returns the pagination metadata.
- getMethod() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
-
The
HttpMethodof 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 interface org.springframework.hateoas.mediatype.ConfiguredAffordance
-
Returns the explicitly configured name of the
Affordanceor calculates a default based on theHttpMethodand 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).
- getNextLink() - Method in class org.springframework.hateoas.SlicedModel
-
Returns the
Linkpointing to the next slice (if set). - getNumber() - Method in class org.springframework.hateoas.PagedModel.PageMetadata
-
Returns the number of the current page.
- getNumber() - Method in class org.springframework.hateoas.SlicedModel.SliceMetadata
-
Returns the number of the current slice.
- 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
- getOrder() - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.CollectionModelProcessorWrapper
- getOutput() - Method in class org.springframework.hateoas.AffordanceModel
- 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
MethodParameterwith 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. - getParams(Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
- getParams(Method) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
- getParams(Method) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
-
Returns the statically declared request parameters.
- 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).
- getPreviousLink() - Method in class org.springframework.hateoas.SlicedModel
-
Returns the
Linkpointing to the previous slice (if set). - getPrimaryMediaType() - Method in interface org.springframework.hateoas.AffordanceModel.InputPayloadMetadata
-
Returns the primary
MediaTypeexpected 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.
- getQueryMethodParameters() - Method in class org.springframework.hateoas.AffordanceModel
- 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
- 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
Methodinvoked on the given type. - getRequiredAffordanceModel(MediaType) - Method in class org.springframework.hateoas.Affordance
-
Look up the
AffordanceModelfor the requestedMediaType. - getRequiredLink(String) - Method in class org.springframework.hateoas.Links
-
Returns the
Linkwith 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.Links
-
Returns the
Linkwith the given relation. - getRequiredLink(LinkRelation) - Method in class org.springframework.hateoas.RepresentationModel
-
Returns the link with the given relation.
- getRequiredLinkDiscovererFor(String) - Method in class org.springframework.hateoas.client.LinkDiscoverers
-
Returns the
LinkDiscoverersuitable for the given media type. - getRequiredLinkDiscovererFor(MediaType) - Method in class org.springframework.hateoas.client.LinkDiscoverers
-
Returns the
LinkDiscoverersuitable for the givenMediaType. - getResolvableType() - Method in class org.springframework.hateoas.CollectionModel
- 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
- 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.
- getSize() - Method in class org.springframework.hateoas.SlicedModel.SliceMetadata
-
Returns the requested size of the slice.
- getStatus() - Method in class org.springframework.hateoas.mediatype.problem.Problem
- getTarget() - Method in interface org.springframework.hateoas.mediatype.ConfiguredAffordance
-
Returns the affordance's target.
- getTargetType() - Method in interface org.springframework.hateoas.server.core.MethodInvocation
- getTargetType() - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.CollectionModelProcessorWrapper
-
Returns the target type the underlying
RepresentationModelProcessorwants to get invoked for. - 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
- 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.core.TypeReferences.$$
- getType() - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
- getType() - Method in class org.springframework.hateoas.TemplateVariable
-
Returns the type of the
TemplateVariable. - getURI() - Method in class org.springframework.hateoas.AffordanceModel
-
Expand the
Linkinto an href with no parameters. - getUriMapping(Class<?>) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
- getUriMapping(Class<?>) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
- getUriMapping(Class<?>) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
-
Returns the mapping associated with the given type.
- getUriMapping(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
- getUriMapping(Class<?>, Method) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
- getUriMapping(Class<?>, Method) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
-
Returns the mapping for the given
Methodinvoked on the given type. - getUriMapping(Class<?>, Method) - Static method in class org.springframework.hateoas.server.core.SpringAffordanceBuilder
-
Returns the mapping for the given type's method.
- getUriMapping(Method) - Method in class org.springframework.hateoas.server.core.AnnotationMappingDiscoverer
- getUriMapping(Method) - Method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
- getUriMapping(Method) - Method in interface org.springframework.hateoas.server.core.MappingDiscoverer
-
Returns the mapping associated with the given
Method. - 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(Annotation) - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
-
Returns the
Annotationattribute's value from the givenAnnotation. - getValueFrom(MethodParameter) - Method in class org.springframework.hateoas.server.core.AnnotationAttribute
-
Reads the
Annotationattribute's value from the givenMethodParameter. - 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
TemplateVariablescontained in theLink. - 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 - Enum constant in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
-
HAL - Hypermedia Application Language.
- HAL_FORMS - Enum constant in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
-
HAL-FORMS - Independent, backward-compatible extension of the HAL designed to add runtime FORM support
- 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
HalConfigurationrendering single links as immediate sub-document. - HalConfiguration.RenderSingleLinks - Enum Class 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
HalFormsConfigurationbacked by a defaultHalConfiguration. - HalFormsConfiguration(HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
-
Creates a new
HalFormsConfigurationfor the givenHalConfiguration. - HalFormsHttpMessageConverter - Class in org.springframework.hateoas.mediatype.hal.forms
-
A
TypeConstrainedMappingJackson2HttpMessageConverterthat will inspect the returnedRepresentationModelfor affordances and flip theMediaTyperendered back toMediaTypes.HAL_JSONif no templates have been registered. - HalFormsHttpMessageConverter(BeanFactory, JsonMapper) - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsHttpMessageConverter
- HalFormsJacksonModule - Class in org.springframework.hateoas.mediatype.hal.forms
-
Serialize / deserialize all the parts of HAL-FORMS documents using Jackson.
- HalFormsJacksonModule() - Constructor for class org.springframework.hateoas.mediatype.hal.forms.HalFormsJacksonModule
- 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
optionsattribute. - 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'inlineattribute or responses of resources pointed to by thelinkobject. - HalHandlerInstantiator(LinkRelationProvider, CurieProvider, MessageResolver) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalHandlerInstantiator
-
Convenience constructor for testing purposes.
- HalHandlerInstantiator(LinkRelationProvider, CurieProvider, MessageResolver, HalConfiguration, AutowireCapableBeanFactory) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalHandlerInstantiator
- HalJacksonModule - Class in org.springframework.hateoas.mediatype.hal
-
Jackson 2 module implementation to render
LinkandRepresentationModelinstances in HAL compatible JSON. - HalJacksonModule() - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule
- HalJacksonModule.EmbeddedMapper - Class in org.springframework.hateoas.mediatype.hal
-
Helper to easily map embedded resources and find out whether they were curied.
- HalJacksonModule.HalHandlerInstantiator - Class in org.springframework.hateoas.mediatype.hal
-
HandlerInstantiator to create HAL-specific serializers, deserializers etc.
- HalJacksonModule.HalLinkListDeserializer - Class in org.springframework.hateoas.mediatype.hal
- HalJacksonModule.HalLinkListSerializer - Class in org.springframework.hateoas.mediatype.hal
-
Custom
ValueSerializerto render Link instances in HAL compatible JSON. - HalJacksonModule.HalResourcesDeserializer - Class in org.springframework.hateoas.mediatype.hal
- HalJacksonModule.HalResourcesSerializer - Class in org.springframework.hateoas.mediatype.hal
-
Custom
ValueSerializerto renderEntityModel-Lists in HAL compatible JSON. - HalJacksonModule.OptionalListJackson2Serializer - Class in org.springframework.hateoas.mediatype.hal
-
Custom
ValueSerializerto render Link instances in HAL compatible JSON. - HalJacksonModule.TrueOnlyBooleanSerializer - Class in org.springframework.hateoas.mediatype.hal
-
ValueSerializerto only renderBooleanvalues if they're set to true. - HalLinkDiscoverer - Class in org.springframework.hateoas.mediatype.hal
-
LinkDiscovererimplementation 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.HalJacksonModule.HalLinkListDeserializer
- HalLinkListSerializer(BeanProperty, CurieProvider, HalJacksonModule.EmbeddedMapper, MessageResolver, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- HalLinkListSerializer(CurieProvider, HalJacksonModule.EmbeddedMapper, MessageResolver, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.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>, ObjectProvider<MediaTypeConfigurationCustomizer<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
HalModelBuilderusing the givenEmbeddedWrappers. - 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
HalModelBuilderwith the given entity as primary payload. - HalResourcesDeserializer() - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesDeserializer
- HalResourcesDeserializer(JavaType) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesDeserializer
- HalResourcesSerializer(HalJacksonModule.EmbeddedMapper, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- HalResourcesSerializer(HalJacksonModule.EmbeddedMapper, HalConfiguration, BeanProperty) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.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.HalJacksonModule.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.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.core.TypeReferences.$$
- hashCode() - Method in class org.springframework.hateoas.server.core.UriMapping
- hashCode() - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
- hashCode() - Method in class org.springframework.hateoas.SlicedModel
- hashCode() - Method in class org.springframework.hateoas.SlicedModel.SliceMetadata
- 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
Affordancehas the givenHttpMethod. - hasLink(String) - Method in class org.springframework.hateoas.Links
- hasLink(String) - Method in class org.springframework.hateoas.RepresentationModel
-
Returns whether the resource contains a
Linkwith the given rel. - hasLink(LinkRelation) - Method in class org.springframework.hateoas.Links
- 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
Linkhas the given link relation. - hasRel(LinkRelation) - Method in class org.springframework.hateoas.Link
-
Returns whether the
Linkhas the givenLinkRelation. - hasRel(LinkRelation) - Method in interface org.springframework.hateoas.server.core.EmbeddedWrapper
-
Returns whether the wrapper has the given rel.
- hasSingleElement(Object) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.OptionalListJackson2Serializer
- hasSingleElement(Collection<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- hasSingleElement(Links) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- hasSingleLink() - Method in class org.springframework.hateoas.Links
- hasSize(long) - Method in class org.springframework.hateoas.Links
-
Returns whether the current
Linkshas 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
ResponseEntitythat exposesLinkinstances in the containedRepresentationModelas 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.Doc.DocBuilder
- href(String) - Method in class org.springframework.hateoas.mediatype.alps.Ext.ExtBuilder
- href(String) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
- HTML - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Format
- HtmlInputType - Class in org.springframework.hateoas.mediatype.html
-
The types of HTML
<input … />elements. - HTTP_PROBLEM_DETAILS - Enum constant in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
- 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
-
A String equivalent of
MediaTypes.HTTP_PROBLEM_DETAILS_JSON_VALUE. - 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. - 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 andAbstractJacksonDecoders needed to wire aWebClientwith hypermedia support. - HypermediaWebTestClientConfigurer - Class in org.springframework.hateoas.config
-
Assembles
Jackson2JsonEncoders andAbstractJacksonDecoders needed to wire aWebTestClientwith 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.Ext.ExtBuilder
- id(String) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
- IDEMPOTENT - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Type
- 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(Collection<? extends Object>) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
-
Creates a new
HalFormsOptions.Inlineoptions representation listing the given collection of values. - inline(T...) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
-
Creates a new
HalFormsOptions.Inlineoptions representation listing the given values. - InputType - Annotation Interface 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
-
A String equivalent of
IanaLinkRelations.INTERVAL_FINISHED_BY. - 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
-
A String equivalent of
IanaLinkRelations.INTERVAL_OVERLAPPED_BY. - 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
-
A String equivalent of
IanaLinkRelations.INTERVAL_STARTED_BY. - 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. - invokeProcessor(Object) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.CollectionModelProcessorWrapper
- invokeProcessorsFor(T) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker
-
Invokes all
RepresentationModelProcessorinstances registered for the type of the given value. - invokeProcessorsFor(T, ResolvableType) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker
-
Invokes all
RepresentationModelProcessorinstances registered for the type of the given value and reference type. - isAlreadyRegisteredIn(JsonMapper) - Static method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule
-
Returns whether the module was already registered in the given
JsonMapper. - isApplyPropertyNamingStrategy() - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
- 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.
- isComposite() - Method in class org.springframework.hateoas.TemplateVariable
-
Returns whether the current
TemplateVariableis a composite one. - 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
Linkscontainer is empty. - isEmpty(SerializationContext, Boolean) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.TrueOnlyBooleanSerializer
- isEmpty(SerializationContext, Object) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.OptionalListJackson2Serializer
- isEmpty(SerializationContext, Collection<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- isEmpty(SerializationContext, Links) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- 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 class 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 Resources<Resource<?>>?
- isSameAs(Link) - Method in class org.springframework.hateoas.Link
-
Returns whether the links are logically the same, i.e. share all link characteristics but might have different affordances attached.
- isSameAs(LinkRelation) - Method in interface org.springframework.hateoas.LinkRelation
-
Returns whether the given
LinkRelationis logically the same as the current one, independent of implementation, i.e. whether the plainStringvalues match. - isSingular() - Method in class org.springframework.hateoas.TemplateVariable
-
Returns whether the current
TemplateVariableis a singular one. - 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. - itemRelation() - Element in annotation interface org.springframework.hateoas.server.core.Relation
-
Defines the relation to be used when referring to a single resource.
- 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.TemplateVariables
- iterator() - Method in class org.springframework.hateoas.UriTemplate
J
- JacksonHelper - Class in org.springframework.hateoas.mediatype
-
Jackson utility methods.
- JacksonHelper() - Constructor for class org.springframework.hateoas.mediatype.JacksonHelper
- JacksonJsonProvider - Class in org.springframework.hateoas.mediatype.jsonpath
- JacksonJsonProvider() - Constructor for class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
-
Initialize the JacksonProvider with the default JsonMapper and ObjectReader
- JacksonJsonProvider(JsonMapper) - Constructor for class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
-
Initialize the JacksonProvider with a custom JsonMapper.
- JacksonJsonProvider(JsonMapper, ObjectReader) - Constructor for class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
-
Initialize the JacksonProvider with a custom JsonMapper and ObjectReader.
- JacksonMappingProvider - Class in org.springframework.hateoas.mediatype.jsonpath
- JacksonMappingProvider() - Constructor for class org.springframework.hateoas.mediatype.jsonpath.JacksonMappingProvider
- JacksonMappingProvider(JsonMapper) - Constructor for class org.springframework.hateoas.mediatype.jsonpath.JacksonMappingProvider
- 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
ValueDeserializerfor Spring'sMediaTypeusing theMediaType.parseMediaType(String)method. - JsonPathLinkDiscoverer - Class in org.springframework.hateoas.client
-
LinkDiscovererthat usesJsonPathto find links inside a representation. - JsonPathLinkDiscoverer(String, MediaType...) - Constructor for class org.springframework.hateoas.client.JsonPathLinkDiscoverer
-
Creates a new
JsonPathLinkDiscovererusing the given path template supporting the givenMediaType.
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. - limit(int) - Method in class org.springframework.hateoas.TemplateVariable
- link(String, LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
- link(Link) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Add a
Linkto the whole thing. - Link - Class in org.springframework.hateoas
-
Value object for links.
- Link() - Constructor for class org.springframework.hateoas.Link
-
Empty constructor required by the marshaling framework.
- Link(String, LinkRelation) - Constructor for class org.springframework.hateoas.Link
-
Creates a new
Linkto the given URI with the given rel. - Link(UriTemplate, LinkRelation) - Constructor for class org.springframework.hateoas.Link
-
Creates a new Link from the given
UriTemplateand rel. - LinkBuilder - Interface in org.springframework.hateoas.server
-
Builder to ease building
Linkinstances. - LinkBuilderFactory<T extends LinkBuilder> - Interface in org.springframework.hateoas.server
-
Factory for
LinkBuilderinstances. - LinkBuilderSupport<T extends LinkBuilder> - Class in org.springframework.hateoas.server.core
-
Base class to implement
LinkBuilders based on a Spring MVCUriComponentsBuilder. - LinkBuilderSupport(UriComponents) - Constructor for class org.springframework.hateoas.server.core.LinkBuilderSupport
-
Creates a new
LinkBuilderSupportusing the givenUriComponents. - 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
PluginRegistryforLinkDiscovererso that it's easier to inject them into clients wanting to lookup aLinkDiscovererfor a givenMediaTypes. - LinkDiscoverers(PluginRegistry<LinkDiscoverer, MediaType>) - Constructor for class org.springframework.hateoas.client.LinkDiscoverers
-
Creates a new
LinkDiscoverersinstance with the givenPluginRegistry. - linkFor(Class<?>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
- linkFor(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
- linkFor(Class<?>) - Method in interface org.springframework.hateoas.server.EntityLinks
-
Returns a
LinkBuilderable to create links to the controller managing the given entity type. - linkFor(Class<?>, Object...) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
- linkFor(Class<?>, Object...) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
- linkFor(Class<?>, Object...) - Method in interface org.springframework.hateoas.server.EntityLinks
-
Returns a
LinkBuilderable 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
LinkBuilderable to create links to the controller managing the given entity type and id. - linkForItemResource(T) - Method in class org.springframework.hateoas.server.TypedEntityLinks
-
Returns a
LinkBuilderable to create links to the controller managing the given entity. - linkForItemResource(T, Function<T, Object>) - Method in interface org.springframework.hateoas.server.EntityLinks
-
Returns a
LinkBuilderable to create links to the controller managing the given entity type and identifier extractor. - 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
-
LinkRelationProviderselection context for item resource relation lookups (LinkRelationProvider.LookupContext.forItemResourceRelLookup(Class), collection resource relation lookupsLinkRelationProvider.LookupContext.forCollectionResourceRelLookup(Class)or bothLinkRelationProvider.LookupContext.forType(Class). - links(Iterable<Link>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Adds the given
Links to theRepresentationModelto be built. - Links - Class in org.springframework.hateoas
-
Value object to represent a list of
Links. - Links.MergeMode - Enum Class in org.springframework.hateoas
-
The mode how to merge two
Linksinstances. - linkTo(Class<?>) - Method in interface org.springframework.hateoas.server.LinkBuilderFactory
-
Creates a new
LinkBuilderwith a base of the mapping annotated to the given target class (controller, service, etc.). - linkTo(Class<?>) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
-
Creates a new
WebMvcLinkBuilderwith a base of the mapping annotated to the given controller class. - linkTo(Class<?>) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkTo(Class<?>, Object...) - Method in interface org.springframework.hateoas.server.LinkBuilderFactory
-
Creates a new
LinkBuilderwith a base of the mapping annotated to the given target class (controller, service, etc.). - linkTo(Class<?>, Object...) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
-
Creates a new
WebMvcLinkBuilderwith a base of the mapping annotated to the given controller class. - linkTo(Class<?>, Object...) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkTo(Class<?>, Method) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
-
Returns a
LinkBuilderpointing to the URI mapped to the givenMethodassuming it was invoked on an object of the given type expanding the mapping using null values as parameters. - linkTo(Class<?>, Method) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
- linkTo(Class<?>, Method) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkTo(Class<?>, Method, Object...) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
-
Returns a
LinkBuilderpointing to the URI mapped to the givenMethodassuming it was invoked on an object of the given type. - linkTo(Class<?>, Method, Object...) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
- linkTo(Class<?>, Method, Object...) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkTo(Class<?>, Map<String, ?>) - Method in interface org.springframework.hateoas.server.LinkBuilderFactory
-
Creates a new
LinkBuilderwith a base of the mapping annotated to the given target class (controller, service, etc.). - linkTo(Class<?>, Map<String, ?>) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
-
Creates a new
WebMvcLinkBuilderwith a base of the mapping annotated to the given controller class. - linkTo(Class<?>, Map<String, ?>) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkTo(Object) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
-
Returns a
LinkBuilderpointing to the URI mapped to the method the result is handed into this method. - linkTo(Object) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
-
Creates a
WebMvcLinkBuilderpointing to a controller method. - linkTo(Object) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkTo(Object) - Static method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder
-
Create a
WebFluxLinkBuilderby checking if the Reactor Context contains aServerWebExchangeand using that combined with the Spring Web annotations to build a full URI. - 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<UriMapping, UriComponentsBuilder>, Supplier<ConversionService>) - Static method in class org.springframework.hateoas.server.core.WebHandler
- linkTo(Object, ServerWebExchange) - Static method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder
-
Create a
WebFluxLinkBuilderusing an explicitly definedServerWebExchange. - linkTo(Method) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
-
Returns a
LinkBuilderpointing to the URI mapped to the givenMethodand expanding this mapping using null values as parameters. - linkTo(Method) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
- linkTo(Method) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkTo(Method, Object...) - Method in interface org.springframework.hateoas.server.MethodLinkBuilderFactory
-
Returns a
LinkBuilderpointing to the URI mapped to the givenMethodand expanding this mapping using the given parameters. - linkTo(Method, Object...) - Static method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilder
- linkTo(Method, Object...) - Method in class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- linkToCollectionResource() - Method in class org.springframework.hateoas.server.TypedEntityLinks.ExtendedTypedEntityLinks
-
Creates a
Linkpointing to the collection resource of the configured type. - 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
Linkpointing to the collection resource of the given type. - linkToCurrentMapping() - Static method in class org.springframework.hateoas.server.mvc.BasicLinkBuilder
-
Creates a new
BasicLinkBuilderto 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
Linkpointing to item resource backing the given entity type and id. - linkToItemResource(T) - Method in class org.springframework.hateoas.server.TypedEntityLinks
-
Creates a
Linkpointing to item resource backing the given entity. - linkToItemResource(T, Function<T, Object>) - Method in interface org.springframework.hateoas.server.EntityLinks
-
Creates a
Linkpointing to item resource backing the given entity and identifier extractor. - 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
- map(Iterable<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.EmbeddedMapper
-
Maps the given source elements as embedded values.
- map(Iterable<? extends T>) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
-
Maps the given
Iterableof entities to either aCollectionModelor simple List ofRepresentationModels. - map(Object, TypeRef<T>, Configuration) - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonMappingProvider
- map(Object, Class<T>, Configuration) - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonMappingProvider
- map(Function<String, String>) - Method in interface org.springframework.hateoas.LinkRelation
-
Returns a new
LinkRelationwith 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(Function<Link, Link>) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
-
Creates a new
WebFluxLinkBuilder.WebFluxLinkwith the currentLinkinstance transformed using the given mapper. - map(LinkRelation) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.EmbeddedMapper
-
Maps the given
HalLinkRelationusing the underlying relation transformer. - mapLink(LinkRelation, Function<Link, Link>) - Method in class org.springframework.hateoas.RepresentationModel
-
Replaces the link(s) with the given
LinkRelationwith 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
LinkRelationwith the mapper applied to each of the links if the given condition is true. - mapper - Variable in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- 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. - MARKDOWN - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Format
- MediaTypeConfigurationCustomizer<T> - Interface in org.springframework.hateoas.mediatype
-
Callback interface to customize media type-specific configuration.
- MediaTypeConfigurationFactory<T,
S extends MediaTypeConfigurationCustomizer<T>> - Class in org.springframework.hateoas.mediatype -
Factory to provide instances of media type-specific configuration processed by
MediaTypeConfigurationCustomizers. - MediaTypeConfigurationFactory(Supplier<T>, ObjectProvider<S>) - Constructor for class org.springframework.hateoas.mediatype.MediaTypeConfigurationFactory
- 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(Iterable<Link>) - Method in class org.springframework.hateoas.Links
- merge(Stream<Link>) - Method in class org.springframework.hateoas.Links
- merge(Link...) - Method in class org.springframework.hateoas.Links
- merge(Links.MergeMode, Iterable<Link>) - Method in class org.springframework.hateoas.Links
-
Merges the current
Linkswith the given ones applying the givenLinks.MergeMode. - merge(Links.MergeMode, Stream<Link>) - Method in class org.springframework.hateoas.Links
-
Merges the current
Linkswith the given ones applying the givenLinks.MergeMode. - merge(Links.MergeMode, Link...) - Method in class org.springframework.hateoas.Links
-
Merges the current
Linkswith the given ones applying the givenLinks.MergeMode. - messageResolver() - Method in class org.springframework.hateoas.config.HateoasConfiguration
- MessageResolver - Interface in org.springframework.hateoas.mediatype
-
A simplified variant of
MessageSourceAccessorto allow more direct replacement with a no-op implementation in case the targetMessageSourceis unavailable to avoid resolution overhead. - MessageSourceResolvableSerializer - Class in org.springframework.hateoas.mediatype
-
A Jackson serializer triggering message resolution via a
MessageResolverforMessageSourceResolvableinstances about to be serialized. - MessageSourceResolvableSerializer(MessageResolver) - Constructor for class org.springframework.hateoas.mediatype.MessageSourceResolvableSerializer
-
Creates a new
MessageSourceResolvableSerializerfor the givenMessageResolver. - MethodInvocation - Interface in org.springframework.hateoas.server.core
- MethodLinkBuilderFactory<T extends LinkBuilder> - Interface in org.springframework.hateoas.server
-
Extension of
LinkBuilderFactoryfor implementations that also support creatingLinkBuilders 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
EmptyTargetSourceto simply drop method invocations but equips it with anDummyInvocationUtils.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 ofWebMvcLinkBuilder. - 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 ofWebFluxLinkBuilder. - MethodParameters - Class in org.springframework.hateoas.server.core
-
Value object to represent
MethodParametersto allow to easily find the ones with a given annotation. - MethodParameters(Method, AnnotationAttribute) - Constructor for class org.springframework.hateoas.server.core.MethodParameters
- 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
Linkinstances fromMvcUriComponentsBuilderinvocations. - 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 interface org.springframework.hateoas.server.core.Relation
- NO_SLICE - Static variable in class org.springframework.hateoas.SlicedModel
- 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. - NonComposite - Annotation Interface in org.springframework.hateoas
-
Annotation to be used in combination with
RequestParamto indicate that collection based values are supposed to be rendered as non-composite values, i.e. likeparam=value1,value2,value3rather thanparam=value1¶m=value2when generating links by pointing to controller methods. - 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(String) - Static method in class org.springframework.hateoas.server.core.UriMapping
-
Creates a new
UriMappingfrom a given source mapping string. - of(MessageSource) - Static method in interface org.springframework.hateoas.mediatype.MessageResolver
-
Obtains a
MessageResolverfor the givenMessageSource. - of(T) - Static method in class org.springframework.hateoas.RepresentationModel
-
Creates a new
RepresentationModelfor the given content object and no links. - of(T, Iterable<Link>) - Static method in class org.springframework.hateoas.RepresentationModel
-
Creates a new
RepresentationModelfor the given content object and links. - of(Iterable<Link>) - Static method in class org.springframework.hateoas.Links
- of(Iterable<T>) - Static method in class org.springframework.hateoas.CollectionModel
-
Creates a
CollectionModelinstance with the given content. - of(Iterable<T>, Iterable<Link>) - Static method in class org.springframework.hateoas.CollectionModel
-
s Creates a
CollectionModelinstance with the given content andLinks. - of(Iterable<T>, Link...) - Static method in class org.springframework.hateoas.CollectionModel
-
Creates a
CollectionModelinstance with the given content andLinks (optional). - of(Object) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
-
Creates a new
Linkfrom the givenMvcUriComponentsBuilderinvocation defaulting to theIanaLinkRelations.SELFlink relation. - of(Object, LinkRelation) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
-
Creates a new
Linkfrom the givenMvcUriComponentsBuilderinvocation. - of(Method) - Static method in class org.springframework.hateoas.server.core.MethodParameters
-
Returns the
MethodParametersfor the givenMethod. - of(String) - Static method in class org.springframework.hateoas.Link
-
Creates a new link to the given URI with the self relation.
- of(String) - Static method in interface org.springframework.hateoas.LinkRelation
-
Creates a new
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
HtmlInputTypefor the given string value. - of(String) - Static method in class org.springframework.hateoas.UriTemplate
-
Returns a
UriTemplatefor the givenStringtemplate. - of(String, Object) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue
-
Creates a new
HalFormsPromptedValuewith the given plain prompt and value. - of(String, String) - Static method in class org.springframework.hateoas.Link
-
Creates a new
Linkto the given href with the given relation. - of(String, LinkRelation) - Static method in class org.springframework.hateoas.Link
-
Creates a new
Linkto the given href andLinkRelation. - of(String, TemplateVariables) - Static method in class org.springframework.hateoas.UriTemplate
-
Returns a
UriTemplatefor the givenStringtemplate. - of(Collection<T>, PagedModel.PageMetadata) - Static method in class org.springframework.hateoas.PagedModel
- of(Collection<T>, PagedModel.PageMetadata, Iterable<Link>) - Static method in class org.springframework.hateoas.PagedModel
- of(Collection<T>, PagedModel.PageMetadata, Link...) - Static method in class org.springframework.hateoas.PagedModel
- of(Collection<T>, SlicedModel.SliceMetadata) - Static method in class org.springframework.hateoas.SlicedModel
- of(Collection<T>, SlicedModel.SliceMetadata, Iterable<Link>) - Static method in class org.springframework.hateoas.SlicedModel
- of(Collection<T>, SlicedModel.SliceMetadata, Link...) - Static method in class org.springframework.hateoas.SlicedModel
- of(Supplier<Object>) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
-
Creates a new
Linkfrom the given lazyMvcUriComponentsBuilderinvocation defaulting to theIanaLinkRelations.SELFlink relation. - of(Supplier<Object>, LinkRelation) - Static method in class org.springframework.hateoas.server.mvc.MvcLink
-
Creates a new
Linkfrom the given lazyMvcUriComponentsBuilderinvocation. - of(MethodParameter) - Static method in class org.springframework.hateoas.QueryParameter
-
Creates a new
QueryParameterfrom the givenMethodParameter. - of(Link) - Static method in class org.springframework.hateoas.mediatype.Affordances
- of(Link...) - Static method in class org.springframework.hateoas.Links
- of(LinkRelation) - Static method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
-
Returns a
HalLinkRelationfor the given generalLinkRelation. - of(MappingDiscoverer) - Static method in class org.springframework.hateoas.server.core.CachingMappingDiscoverer
- of(UriTemplate, String) - Static method in class org.springframework.hateoas.Link
-
Creates a new
Linkto the givenUriTemplateand link relation. - of(UriTemplate, LinkRelation) - Static method in class org.springframework.hateoas.Link
- of(T) - Static method in class org.springframework.hateoas.EntityModel
-
Creates a new
EntityModelwith the given content. - of(JsonMapper, List<HypermediaMappingInformation>) - Static method in class org.springframework.hateoas.config.WebConverters
- of(T, Iterable<Link>) - Static method in class org.springframework.hateoas.EntityModel
-
Creates a new
EntityModelwith the given content andLinks. - of(T, Link...) - Static method in class org.springframework.hateoas.EntityModel
-
Creates a new
EntityModelwith the given content andLinks (optional). - ofI18ned(String, Object) - Static method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue
-
Creates a new
HalFormsPromptedValuewith 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
QueryParameterwith the given name; - OptionalListJackson2Serializer(BeanProperty, HalConfiguration) - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.OptionalListJackson2Serializer
-
Creates a new
HalJacksonModule.OptionalListJackson2Serializerusing the givenBeanProperty. - org.springframework.hateoas - package org.springframework.hateoas
-
Value objects to ease creating
Links and link driven representations for REST webservices. - org.springframework.hateoas.aot - package org.springframework.hateoas.aot
-
AOT support.
- 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
-
General media type 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.jsonpath - package org.springframework.hateoas.mediatype.jsonpath
- 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.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 assembleRepresentationModeltypes. - org.springframework.hateoas.server.reactive - package org.springframework.hateoas.server.reactive
-
Spring WebFlux components to build
Links and assembleRepresentationModeltypes. - 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) - Constructor for class org.springframework.hateoas.PagedModel
- PagedModel(Collection<T>, PagedModel.PageMetadata, Iterable<Link>) - Constructor for class org.springframework.hateoas.PagedModel
- PagedModel(Collection<T>, PagedModel.PageMetadata, Iterable<Link>, ResolvableType) - Constructor for class org.springframework.hateoas.PagedModel
- 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) - Constructor for class org.springframework.hateoas.PagedModel.PageMetadata
-
Creates a new
PagedModel.PageMetadatafrom the given size, number and total elements. - PageMetadata(long, long, long, long) - Constructor for class org.springframework.hateoas.PagedModel.PageMetadata
-
Creates a new
PagedModel.PageMetadatafrom the given size, number, total elements and total pages. - parse(byte[]) - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- parse(String) - Static method in class org.springframework.hateoas.Links
-
Creates a
Linksinstance from the given RFC-8288-compatible link format. - parse(InputStream, String) - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- parse(String) - Static method in class org.springframework.hateoas.IanaLinkRelations
-
Convert a string-based link relation to a
IanaLinkRelations. - parse(String) - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- PASSWORD - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
- PASSWORD_VALUE - Static variable in class org.springframework.hateoas.mediatype.html.HtmlInputType
- PATH_SEGMENT - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- PATH_STYLE_PARAMETER - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- pathVariable(String) - Static method in class org.springframework.hateoas.TemplateVariable
-
Static helper to fashion
VariableType#PATH_VARIABLEvariables. - 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
Affordancepoints to the target of the givenLink. - 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
-
A String equivalent of
IanaLinkRelations.PREDECESSOR_VERSION. - 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. - prepareAndEncode(Object) - Method in class org.springframework.hateoas.TemplateVariable
- 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(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
Collectionas preview. - preview(Collection<?>, Class<?>) - Method in class org.springframework.hateoas.mediatype.hal.HalModelBuilder
-
Starts a preview setup for the given
Collectionas preview falling back to the given type if theCollectionis empty. - PREVIEW - Static variable in class org.springframework.hateoas.IanaLinkRelations
-
Refers to a resource that provides a preview of the link's context.
- 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, Integer, String, URI) - Constructor for class org.springframework.hateoas.mediatype.problem.Problem
- Problem(URI, String, HttpStatus, String, URI) - 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.
- processAheadOfTime(RegisteredBean) - Method in class org.springframework.hateoas.aot.ControllerMethodReturnTypeAotProcessor
- 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<?>> - Interface in org.springframework.hateoas.server.reactive -
Reactive variant of
RepresentationModelAssemblercombined withSimpleRepresentationModelAssembler. - reader - Variable in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- 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 andAbstractJacksonDecoders to thisWebClient.Builder. - registerInstance(Object) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
- rel(String) - Static method in class org.springframework.hateoas.client.Hop
-
Creates a new
Hopfor the given relation name. - 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
HalLinkRelationbased on the current curie settings. - Relation - Annotation Interface in org.springframework.hateoas.server.core
-
Annotation to configure the relation to be used when embedding objects in HAL representations of
EntityModels andCollectionModel. - remote(String) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
-
Creates a new
HalFormsOptions.Remoteoptions representation using the given href. - remote(Link) - Static method in interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions
-
Creates a new
HalFormsOptions.Remoteoptions representation using the givenLink. - removeLinks() - Method in class org.springframework.hateoas.RepresentationModel
-
Removes all
Links added to the resource so far. - REPLACE_BY_REL - Enum constant in enum class org.springframework.hateoas.Links.MergeMode
-
Replaces existing links with the same link relation.
- 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(Iterable<Link>) - Constructor for class org.springframework.hateoas.RepresentationModel
- RepresentationModel(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
RepresentationModelAssemblerSupportusing 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
RepresentationModelinstances returned from Spring MVC controllers. - RepresentationModelProcessorHandlerMethodReturnValueHandler - Class in org.springframework.hateoas.server.mvc
-
HandlerMethodReturnValueHandlerto post-process the objects returned from controller methods using the configuredRepresentationModelProcessors. - 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
RepresentationModelProcessorinstances registered for values of typeRepresentationModel. - RepresentationModelProcessorInvoker(Collection<RepresentationModelProcessor<?>>) - Constructor for class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker
-
Creates a new
RepresentationModelProcessorInvokerto consider the givenRepresentationModelProcessorto post-process the controller methods return value to before invoking the delegate. - RepresentationModelProcessorInvoker.CollectionModelProcessorWrapper - Class in org.springframework.hateoas.server.mvc
-
RepresentationModelProcessorInvoker.ProcessorWrapperforRepresentationModelProcessors targetingCollectionModel. - REQUEST_PARAM - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- REQUEST_PARAM_CONTINUED - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- requestParameter(String) - Static method in class org.springframework.hateoas.TemplateVariable
-
Static helper to fashion
TemplateVariable.VariableType.REQUEST_PARAMvariables. - requestParameterContinued(String) - Static method in class org.springframework.hateoas.TemplateVariable
-
Static helper to fashion
TemplateVariable.VariableType.REQUEST_PARAM_CONTINUEDvariables. - required(String) - Static method in class org.springframework.hateoas.QueryParameter
-
Creates a new required
QueryParameterwith the given name; - RESERVED_STRING - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- reservedString(String) - Static method in class org.springframework.hateoas.TemplateVariable
-
Static helper to fashion
TemplateVariable.VariableType.RESERVED_STRINGvariables. - resetCache() - Static method in class org.springframework.hateoas.server.core.DummyInvocationUtils
- 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
- SAFE - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Type
- 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
VariableType#SEGMENTvariables. - 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. - SEMANTIC - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Type
- serialize(Boolean, JsonGenerator, SerializationContext) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.TrueOnlyBooleanSerializer
- serialize(Object, JsonGenerator, SerializationContext) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.OptionalListJackson2Serializer
- serialize(Collection<?>, JsonGenerator, SerializationContext) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- serialize(MessageSourceResolvable, JsonGenerator, SerializationContext) - Method in class org.springframework.hateoas.mediatype.MessageSourceResolvableSerializer
- serialize(Links, JsonGenerator, SerializationContext) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- 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
ApplicationContextfor 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
LinkBuilderFactoryto be used to createLinkBuilderinstances. - setLinkDiscoverers(List<? extends LinkDiscoverer>) - Method in class org.springframework.hateoas.client.Traverson
-
Sets the
LinkDiscoverersto use. - setRestOperations(RestOperations) - Method in class org.springframework.hateoas.client.Traverson
-
Configures the
RestOperationsto 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
UriComponentsContributorto be used when buildingLinkinstances from method invocations. - simple(String) - Static method in class org.springframework.hateoas.TemplateVariable
-
Alias of
TemplateVariable.pathVariable(String). - SIMPLE - Enum constant in enum class org.springframework.hateoas.TemplateVariable.VariableType
- SimpleReactiveRepresentationModelAssembler<T> - Interface in org.springframework.hateoas.server.reactive
-
Reactive variant of
RepresentationModelAssemblercombined withSimpleRepresentationModelAssembler. - SimpleRepresentationModelAssembler<T> - Interface in org.springframework.hateoas.server
-
A
RepresentationModelAssemblerbased purely on the domain type, usingEntityRepresentationModel<T>as the enclosing representation model type. - singular() - Method in class org.springframework.hateoas.TemplateVariable
-
Marks the current template variable as singular value.
- SINGULAR - Enum constant in enum class org.springframework.hateoas.TemplateVariable.Cardinality
- SKIP_BY_EQUALITY - Enum constant in enum class org.springframework.hateoas.Links.MergeMode
-
Skips to add the same links on merge.
- SKIP_BY_REL - Enum constant in enum class org.springframework.hateoas.Links.MergeMode
-
Skips to add links with the same link relation, i.e. existing ones with the same relation are preferred.
- slash(Object) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
- slash(Object) - Method in interface org.springframework.hateoas.server.LinkBuilder
-
Adds the given object's
Stringrepresentation as sub-resource to the current URI. - slash(String) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
-
Creates a new
WebFluxLinkBuilder.WebFluxBuilderappending the given path to the currently to be built link. - slash(UriComponents, boolean) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
- SlicedModel<T> - Class in org.springframework.hateoas
-
DTO to implement binding response representations of Slice collections.
- SlicedModel() - Constructor for class org.springframework.hateoas.SlicedModel
-
Default constructor to allow instantiation by reflection.
- SlicedModel(Collection<T>, SlicedModel.SliceMetadata) - Constructor for class org.springframework.hateoas.SlicedModel
- SlicedModel(Collection<T>, SlicedModel.SliceMetadata, Iterable<Link>) - Constructor for class org.springframework.hateoas.SlicedModel
- SlicedModel(Collection<T>, SlicedModel.SliceMetadata, Iterable<Link>, ResolvableType) - Constructor for class org.springframework.hateoas.SlicedModel
- SlicedModel.SliceMetadata - Class in org.springframework.hateoas
-
Value object for slice metadata.
- SliceMetadata() - Constructor for class org.springframework.hateoas.SlicedModel.SliceMetadata
- SliceMetadata(long, long) - Constructor for class org.springframework.hateoas.SlicedModel.SliceMetadata
-
Creates a new
SlicedModel.SliceMetadatafrom the given size, and slice number. - SpringAffordanceBuilder - Class in org.springframework.hateoas.server.core
-
Extract information needed to assemble an
Affordancefrom a Spring MVC web method. - SpringAffordanceBuilder() - Constructor for class org.springframework.hateoas.server.core.SpringAffordanceBuilder
- stacks() - Element in annotation interface org.springframework.hateoas.config.EnableHypermediaSupport
-
Configures which
WebStacks we're supposed to enable support for. - 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
- stream() - Method in interface org.springframework.hateoas.AffordanceModel.PayloadMetadata
-
Returns all properties contained in a payload.
- stream() - Method in class org.springframework.hateoas.Links
- stream() - Method in class org.springframework.hateoas.mediatype.Affordances
-
Returns all
Affordances created. - stream() - Method in class org.springframework.hateoas.TemplateVariables
- 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(Class<?>) - Method in class org.springframework.hateoas.server.core.ControllerEntityLinks
- supports(Class<?>) - Method in class org.springframework.hateoas.server.core.DelegatingEntityLinks
- supports(ResolvableType, Object) - Method in class org.springframework.hateoas.server.mvc.RepresentationModelProcessorInvoker.CollectionModelProcessorWrapper
- supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
- supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.hateoas.server.core.DefaultLinkRelationProvider
- 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
LinkRelationProviderimplementations based on a givenLinkRelationProvider.LookupContext. - supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider
- supports(MediaType) - Method in class org.springframework.hateoas.mediatype.uber.UberLinkDiscoverer
- 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
UriComponentsBuildersupports the givenMethodParameter. - 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
UriTemplatefor 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
TemplateVariablewith the given name and type. - TemplateVariable(String, TemplateVariable.VariableType, String) - Constructor for class org.springframework.hateoas.TemplateVariable
- TemplateVariable.Cardinality - Enum Class in org.springframework.hateoas
-
The cardinality of the
TemplateVariable. - TemplateVariable.VariableType - Enum Class in org.springframework.hateoas
-
An enumeration for all supported variable types.
- TemplateVariableAwareLinkBuilderSupport<T extends TemplateVariableAwareLinkBuilderSupport<T>> - Class in org.springframework.hateoas.server.core
-
A
LinkBuilderSupportextension that can keep a list ofTemplateVariablesaround. - 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(List<TemplateVariable>) - Constructor for class org.springframework.hateoas.TemplateVariables
-
Creates a new
TemplateVariablesfor the givenTemplateVariables. - TemplateVariables(TemplateVariable...) - Constructor for class org.springframework.hateoas.TemplateVariables
-
Creates a new
TemplateVariablesfor the givenTemplateVariables. - 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 - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Format
- 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(Iterable<? extends T>) - Method in interface org.springframework.hateoas.server.RepresentationModelAssembler
-
Converts an
IterableorTs into anIterableofRepresentationModeland wraps them in aCollectionModelinstance. - 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.
- toCollectionModel(Flux<? extends T>, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.ReactiveRepresentationModelAssembler
-
Converts an
IterableorTs into anIterableofRepresentationModeland wraps them in aCollectionModelinstance. - 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.
- toEntity(Class<T>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
-
Returns the raw
ResponseEntitywith the representation unmarshalled into an instance of the given type. - toJson(Object) - Method in class org.springframework.hateoas.mediatype.jsonpath.JacksonJsonProvider
- toLink() - Method in interface org.springframework.hateoas.mediatype.AffordanceOperations
-
Returns a
Linkequipped with theAffordancecurrently under construction. - 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
Linkfrom the givenWebFluxLinkBuilder. - toList() - Method in class org.springframework.hateoas.Links
- toModel(T) - Method in interface org.springframework.hateoas.server.RepresentationModelAssembler
-
Converts the given entity into a
D, which extendsRepresentationModel. - toModel(T) - Method in interface org.springframework.hateoas.server.SimpleRepresentationModelAssembler
-
Converts the given entity into a
EntityModel. - toModel(T, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.ReactiveRepresentationModelAssembler
-
Converts the given entity into a
D, which extendsRepresentationModel. - toModel(T, ServerWebExchange) - Method in interface org.springframework.hateoas.server.reactive.SimpleReactiveRepresentationModelAssembler
-
Converts the given entity into a
EntityModelwrapped in aMono. - toMono() - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
-
Returns the underlying
MonoofLinkfor further handling within a reactive pipeline. - toMono(Function<Link, Link>) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxLink
- 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(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.
- 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. - 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 class org.springframework.hateoas.mediatype.alps.Format
- toString() - Method in enum class 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.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.core.TypeReferences.$$
- toString() - Method in class org.springframework.hateoas.server.core.UriMapping
- toString() - Method in class org.springframework.hateoas.server.LinkRelationProvider.LookupContext
- toString() - Method in class org.springframework.hateoas.SlicedModel.SliceMetadata
- toString() - Method in class org.springframework.hateoas.SlicedModel
- toString() - Method in class org.springframework.hateoas.TemplateVariable
- toString() - Method in enum class 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
UriComponentsBuilderto 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, List<MediaType>) - Constructor for class org.springframework.hateoas.client.Traverson
-
Creates a new
Traversoninteracting with the given base URI and using the givenMediaTypes to interact with the service. - Traverson(URI, MediaType...) - Constructor for class org.springframework.hateoas.client.Traverson
-
Creates a new
Traversoninteracting with the given base URI and using the givenMediaTypes 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
- TrueOnlyBooleanSerializer() - Constructor for class org.springframework.hateoas.mediatype.hal.HalJacksonModule.TrueOnlyBooleanSerializer
- type() - Element in annotation interface org.springframework.hateoas.config.EnableHypermediaSupport
-
The hypermedia type to be supported.
- type(Type) - Method in class org.springframework.hateoas.mediatype.alps.Descriptor.DescriptorBuilder
- Type - Enum Class in org.springframework.hateoas.mediatype.alps
-
An enum for ALPS descriptor types
- 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_VALUE - Static variable in class org.springframework.hateoas.IanaLinkRelations
-
A String equivalent of
IanaLinkRelations.TYPE. - TypeConstrainedJacksonJsonHttpMessageConverter - Class in org.springframework.hateoas.server.mvc
-
Extension of
MappingJackson2HttpMessageConverterto constrain the ability to read and write HTTP message based on the target type. - TypeConstrainedJacksonJsonHttpMessageConverter(Class<?>) - Constructor for class org.springframework.hateoas.server.mvc.TypeConstrainedJacksonJsonHttpMessageConverter
-
Creates a new
TypeConstrainedMappingJackson2HttpMessageConverterfor the given type. - TypeConstrainedJacksonJsonHttpMessageConverter(Class<?>, List<MediaType>, JsonMapper) - Constructor for class org.springframework.hateoas.server.mvc.TypeConstrainedJacksonJsonHttpMessageConverter
-
Convenience constructor to supply all parameters at once.
- TypedEntityLinks<T> - Class in org.springframework.hateoas.server
-
Entity links API to create
Links andLinkBuilderinstances based on an identifier function. - TypedEntityLinks.ExtendedTypedEntityLinks<T> - Class in org.springframework.hateoas.server
-
Extension of
TypedEntityLinksthat 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
ParameterizedTypeReferenceinstances to Spring HATEOAS resource types. - TypeReferences() - Constructor for class org.springframework.hateoas.server.core.TypeReferences
- TypeReferences.$$<T> - Class in org.springframework.hateoas.server.core
- TypeReferences.CollectionModelType<T> - Class in org.springframework.hateoas.server.core
-
A
ParameterizedTypeReferenceto return aCollectionModelof some type. - TypeReferences.EntityModelType<T> - Class in org.springframework.hateoas.server.core
-
A
ParameterizedTypeReferenceto return aEntityModelof some type. - TypeReferences.PagedModelType<T> - Class in org.springframework.hateoas.server.core
-
A
ParameterizedTypeReferenceto return aPagedModelof some type. - typeResolverBuilderInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.hateoas.mediatype.ConfigurableHandlerInstantiator
U
- UBER - Enum constant in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
-
UBER Hypermedia
- 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. - UberJacksonModule - Class in org.springframework.hateoas.mediatype.uber
-
Jackson
SimpleModulefor UBER+JSON serializers and deserializers. - UberJacksonModule() - Constructor for class org.springframework.hateoas.mediatype.uber.UberJacksonModule
- 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. - UNSAFE - Enum constant in enum class org.springframework.hateoas.mediatype.alps.Type
- 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
UriComponentsBuilderwhen referring to a method through a dummy method invocation. - UriMapping - Class in org.springframework.hateoas.server.core
-
A URI mapping on a controller method.
- 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
UriTemplateinstances. - 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() - Element in annotation interface org.springframework.hateoas.InputType
- value() - Method in interface org.springframework.hateoas.LinkRelation
-
Return the link relation's value.
- value() - Method in class org.springframework.hateoas.mediatype.hal.HalLinkRelation
- value() - Method in class org.springframework.hateoas.mediatype.html.HtmlInputType
- value() - Element in annotation interface org.springframework.hateoas.server.core.Relation
-
Defines the relation to be used when referring to a single resource.
- value() - Element in annotation interface org.springframework.hateoas.server.ExposesResourceFor
-
The domain type the controller exposes resources for.
- value(String) - Method in class org.springframework.hateoas.mediatype.alps.Doc.DocBuilder
- value(String) - Method in class org.springframework.hateoas.mediatype.alps.Ext.ExtBuilder
- valueOf(String) - Static method in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in class org.springframework.hateoas.Link
- valueOf(String) - Static method in enum class org.springframework.hateoas.Links.MergeMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.hateoas.mediatype.alps.Format
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.hateoas.mediatype.alps.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.hateoas.mediatype.hal.HalConfiguration.RenderSingleLinks
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.hateoas.support.WebStack
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.hateoas.TemplateVariable.Cardinality
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.hateoas.TemplateVariable.VariableType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.hateoas.Links.MergeMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.hateoas.mediatype.alps.Format
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.hateoas.mediatype.alps.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.hateoas.mediatype.hal.HalConfiguration.RenderSingleLinks
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.hateoas.support.WebStack
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.hateoas.TemplateVariable.Cardinality
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.hateoas.TemplateVariable.VariableType
-
Returns an array containing the constants of this enum class, 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. - VND_HAL_JSON - Static variable in class org.springframework.hateoas.MediaTypes
-
Public constant media type for
application/vnd.hal+json. - VND_HAL_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
-
A String equivalent of
MediaTypes.VND_HAL_JSON.
W
- WebConverters - Class in org.springframework.hateoas.config
-
Value type to handle registration of hypermedia related
HttpMessageConverters. - WEBFLUX - Enum constant in enum class org.springframework.hateoas.support.WebStack
- 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
Linkwithin a reactive pipeline to easily addAffordances 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. - WEBMVC - Enum constant in enum class org.springframework.hateoas.support.WebStack
- WebMvcLinkBuilder - Class in org.springframework.hateoas.server.mvc
-
Builder to ease building
Linkinstances pointing to Spring MVC controllers. - WebMvcLinkBuilderFactory - Class in org.springframework.hateoas.server.mvc
-
Factory for
LinkBuilderSupportinstances based on the request mapping annotated on the given controller. - WebMvcLinkBuilderFactory() - Constructor for class org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory
- WebStack - Enum Class 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
-
Create a new concrete
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.HalJacksonModule.EmbeddedMapper
-
Registers the given
PropertyNamingStrategywith the current mapper to forward that strategy as relation transformer, so thatLinkRelations used as key for the embedding will be transformed using the given strategy. - with(String, TemplateVariable.VariableType) - Method in class org.springframework.hateoas.UriTemplate
-
Creates a new
UriTemplatewith aTemplateVariablewith the given name and type added. - with(TemplateVariable) - Method in class org.springframework.hateoas.UriTemplate
-
Creates a new
UriTemplatewith the givenTemplateVariableadded. - with(TemplateVariables) - Method in class org.springframework.hateoas.UriTemplate
-
Creates a new
UriTemplatewith the currentTemplateVariables augmented with the given ones. - withAffordances(List<Affordance>) - Method in class org.springframework.hateoas.Link
-
Creates a new
Linkwith the givenAffordances. - withApplyPropertyNamingStrategy(boolean) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
-
Create a new
HalConfigurationby copying the attributes and replacing the applyProperNamingStrategy. - withDefaultSingleTemplate(boolean) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
-
Configures whether to use the name
defaultin case only a single template appears. - withDeprecation(String) - Method in class org.springframework.hateoas.Link
-
Create a new
Linkby 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
Problemby copying its attributes and replacing the detail. - withEnforceEmbeddedCollections(boolean) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
-
Create a new
HalConfigurationby copying the attributes and replacing the enforceEmbeddedCollections. - withFallbackType(Class<? super T>, Class<?>...) - Method in class org.springframework.hateoas.CollectionModel
-
Declares the given type as fallback element type in case the underlying collection is empty.
- withFallbackType(Class<? super T>, Class<?>...) - Method in class org.springframework.hateoas.PagedModel
- withFallbackType(Class<? super T>, Class<?>...) - Method in class org.springframework.hateoas.SlicedModel
- withFallbackType(ParameterizedTypeReference<?>) - Method in class org.springframework.hateoas.CollectionModel
-
Declares the given type as fallback element type in case the underlying collection is empty.
- withFallbackType(ParameterizedTypeReference<?>) - Method in class org.springframework.hateoas.PagedModel
- withFallbackType(ParameterizedTypeReference<?>) - Method in class org.springframework.hateoas.SlicedModel
- withFallbackType(ResolvableType) - Method in class org.springframework.hateoas.CollectionModel
-
Declares the given type as fallback element type in case the underlying collection is empty.
- withFallbackType(ResolvableType) - Method in class org.springframework.hateoas.PagedModel
- withFallbackType(ResolvableType) - Method in class org.springframework.hateoas.SlicedModel
- withHeaders(HttpHeaders) - Method in class org.springframework.hateoas.client.Hop
-
Create a new
Hopby copying all the attributes and replacing the headers. - withHeaders(HttpHeaders) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
-
The
HttpHeadersthat shall be used for the requests of the traversal. - withHref(String) - Method in class org.springframework.hateoas.Link
-
Create a new
Linkby copying all attributes and applying the new href. - withHreflang(String) - Method in class org.springframework.hateoas.Link
-
Create a new
Linkby copying all attributes and applying the new hreflang. - 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
ResolvableTypeas input model for the affordance. - withInput(AffordanceModel.PayloadMetadata) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Registers the given
AffordanceModel.PayloadMetadataas input model. - 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
ResolvableTypeas input and output model for the affordance. - withInputAndOutput(AffordanceModel.PayloadMetadata) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Registers the given
AffordanceModel.PayloadMetadataas input and output model. - 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 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
Problemby copying its attributes and replacing the instance. - withMapperBuilderCustomizer(UnaryOperator<JsonMapper.Builder>) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
-
Register the given
UnaryOperatorto apply additional customizations on theJsonMapper.Builderused to render HAL documents. - withMapperBuilderCustomizer(UnaryOperator<JsonMapper.Builder>) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
-
Configures an
JsonMapper.Buildercustomizer to tweak the instance after it has been pre-configured with all HAL specific setup. - 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
Linkby copying all attributes and applying the new media. - withMediaType(MediaType) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
-
Registers additional media types that are supposed to be aliases to
MediaTypes.HAL_FORMS_JSON. - 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.InputPayloadMetadatawith the givenMediaTypeassigned. - 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
Linkby copying all attributes and applying the new name. - withName(String) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Create a new
ConfigurableAffordanceby copying all attributes and replacing the name. - withOptions(Class<T>, String, Function<AffordanceModel.PropertyMetadata, HalFormsOptions>) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
-
Returns a new
HalFormsConfigurationwith the given - without(LinkRelation) - Method in class org.springframework.hateoas.Links
- withoutAffordances() - Method in class org.springframework.hateoas.Link
-
Returns a new
Linkwithout anyAffordances. - 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
ResolvableTypeas the output model. - withOutput(AffordanceModel.PayloadMetadata) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Registers the given
AffordanceModel.PayloadMetadataas output model. - withParameter(String, Object) - Method in class org.springframework.hateoas.client.Hop
-
Add one parameter to the map of parameters.
- withParameters(List<QueryParameter>) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Replaces the current
QueryParameterlist with the given ones. - withParameters(Map<String, Object>) - Method in class org.springframework.hateoas.client.Hop
-
Create a new
Hopby copying all the attributes and replacing the parameters. - withParameters(QueryParameter...) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Replaces the current
QueryParameterlist 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
Linkby 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(Consumer<Map<String, Object>>) - Method in class org.springframework.hateoas.mediatype.problem.Problem
-
Returns an
Problem.ExtendedProblemwith aMap<String,populated by the given consumer as payload.Object> - withProperties(Map<String, Object>) - Method in class org.springframework.hateoas.mediatype.problem.Problem
-
Returns an
Problem.ExtendedProblemwith the givenMapunwrapping as additional properties. - 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.ExtendedProblemwith the given payload as additional properties. - withRel(String) - Method in class org.springframework.hateoas.Link
-
Creates a new
Linkwith the same href but givenLinkRelation. - withRel(String) - Method in interface org.springframework.hateoas.server.LinkBuilder
-
Creates the
Linkbuilt by the current builder instance with the given link relation. - withRel(String) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
-
Creates a new
WebFluxLinkBuilder.WebFluxLinkfor theLinkwith the given link relation. - withRel(LinkRelation) - Method in class org.springframework.hateoas.Link
-
Creates a new
Linkwith the same href but givenLinkRelation. - withRel(LinkRelation) - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
- withRel(LinkRelation) - Method in interface org.springframework.hateoas.server.LinkBuilder
-
Creates the
Linkbuilt by the current builder instance with the givenLinkRelation. - withRel(LinkRelation) - Method in class org.springframework.hateoas.server.reactive.WebFluxLinkBuilder.WebFluxBuilder
- withRenderSingleLinks(HalConfiguration.RenderSingleLinks) - Method in class org.springframework.hateoas.mediatype.hal.HalConfiguration
-
Create a new
HalConfigurationby copying the attributes and replacing the renderSingleLinks. - 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 (likeacme:*) or even complete URIs (likehttps://api.acme.com/foo/**). - 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. - 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
Linkpointing to the same URI but with theselfrelation. - withSelfRel() - Method in class org.springframework.hateoas.server.core.LinkBuilderSupport
- withSelfRel() - Method in interface org.springframework.hateoas.server.LinkBuilder
-
Creates the
Linkbuilt 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
Problemby copying its attributes and replacing the status. - withTarget(Link) - Method in interface org.springframework.hateoas.mediatype.ConfigurableAffordance
-
Create a new
ConfigurableAffordanceby 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
Linkby 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
Problemby copying its attributes and replacing the title. - withType(String) - Method in class org.springframework.hateoas.Link
-
Create a new
Linkby 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
Problemby copying its attributes and replacing the type. - withValue(String) - Method in class org.springframework.hateoas.QueryParameter
-
Create a new
QueryParameterby 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
CollectionModelinstance by wrapping the given domain class instances into aEntityModel. - wrap(Iterable<S>, PagedModel.PageMetadata) - Static method in class org.springframework.hateoas.PagedModel
-
Factory method to easily create a
PagedModelinstance from a set of entities and pagination metadata. - wrap(Iterable<S>, SlicedModel.SliceMetadata) - Static method in class org.springframework.hateoas.SlicedModel
-
Factory method to easily create a
SlicedModelinstance from a set of entities and pagination metadata. - wrap(Object) - Method in class org.springframework.hateoas.server.core.EmbeddedWrappers
-
Creates a new
EmbeddedWrapperthat - wrap(Object, LinkRelation) - Method in class org.springframework.hateoas.server.core.EmbeddedWrappers
-
Creates a new
EmbeddedWrapperwith the given rel. - wrap(HttpEntity<S>) - Static method in class org.springframework.hateoas.server.core.HeaderLinksResponseEntity
-
Wraps the given
HttpEntityinto aHeaderLinksResponseEntity. - wrap(S) - Static method in class org.springframework.hateoas.server.core.HeaderLinksResponseEntity
-
Wraps the given
RepresentationModelinto aHeaderLinksResponseEntity. - writeInternal(Object, ResolvableType, HttpOutputMessage, Map<String, Object>) - Method in class org.springframework.hateoas.mediatype.hal.forms.HalFormsHttpMessageConverter
_
- _withValueTypeSerializer(TypeSerializer) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalLinkListSerializer
- _withValueTypeSerializer(TypeSerializer) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.HalResourcesSerializer
- _withValueTypeSerializer(TypeSerializer) - Method in class org.springframework.hateoas.mediatype.hal.HalJacksonModule.OptionalListJackson2Serializer
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form