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

A

AbstractEntityLinks - Class in org.springframework.hateoas.core
Implementation base class to delegate the higher level methods of EntityLinks by delegating to the more fine grained ones to reduce the implementation effort for actual implementation classes.
AbstractEntityLinks() - Constructor for class org.springframework.hateoas.core.AbstractEntityLinks
 
acceptJsonFormatVisitor(JsonFormatVisitorWrapper, JavaType) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
add(Link) - Method in class org.springframework.hateoas.ResourceSupport
Adds the given link to the resource.
add(Iterable<Link>) - Method in class org.springframework.hateoas.ResourceSupport
Adds all given Links to the resource.
add(Link...) - Method in class org.springframework.hateoas.ResourceSupport
Adds all given Links to the resource.
add(VndErrors.VndError) - Method in class org.springframework.hateoas.VndErrors
Adds an additional VndErrors.VndError to the wrapper.
afterPropertiesSet() - Method in class org.springframework.hateoas.core.ControllerEntityLinksFactoryBean
 
afterPropertiesSet() - Method in class org.springframework.hateoas.mvc.ResourceProcessorInvokingHandlerAdapter
 
Alps - Class in org.springframework.hateoas.alps
An ALPS document.
Alps() - Constructor for class org.springframework.hateoas.alps.Alps
 
ALPS_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/alps+json.
ALPS_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.ALPS_JSON.
AlpsLinkDiscoverer - Class in org.springframework.hateoas.alps
LinkDiscoverer implementation to find ALPS-based links.
AlpsLinkDiscoverer() - Constructor for class org.springframework.hateoas.alps.AlpsLinkDiscoverer
 
AnnotationAttribute - Class in org.springframework.hateoas.core
Simply helper to reference a dedicated attribute of an Annotation.
AnnotationAttribute(Class<? extends Annotation>) - Constructor for class org.springframework.hateoas.core.AnnotationAttribute
Creates a new AnnotationAttribute to the value attribute of the given Annotation type.
AnnotationAttribute(Class<? extends Annotation>, String) - Constructor for class org.springframework.hateoas.core.AnnotationAttribute
Creates a new AnnotationAttribute for the given Annotation type and annotation attribute name.
AnnotationMappingDiscoverer - Class in org.springframework.hateoas.core
MappingDiscoverer implementation that inspects mappings from a particular annotation.
AnnotationMappingDiscoverer(Class<? extends Annotation>) - Constructor for class org.springframework.hateoas.core.AnnotationMappingDiscoverer
Creates an AnnotationMappingDiscoverer for the given annotation type.
AnnotationMappingDiscoverer(Class<? extends Annotation>, String) - Constructor for class org.springframework.hateoas.core.AnnotationMappingDiscoverer
Creates an AnnotationMappingDiscoverer for the given annotation type and attribute name.
AnnotationRelProvider - Class in org.springframework.hateoas.core
 
AnnotationRelProvider() - Constructor for class org.springframework.hateoas.core.AnnotationRelProvider
 
applyUriComponentsContributer(UriComponentsBuilder, DummyInvocationUtils.MethodInvocation) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
Applies the configured UriComponentsContributors to the given UriComponentsBuilder.
asLink() - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Returns the Link found for the last rel in the rels configured to follow.
asList() - Method in class org.springframework.hateoas.TemplateVariables
Returns the contained TemplateVariables as List.
asTemplatedLink() - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Returns the templated Link found for the last rel in the rels configured to follow.
ATOM_NAMESPACE - Static variable in class org.springframework.hateoas.Link
 

B

BasicLinkBuilder - Class in org.springframework.hateoas.mvc
Simples LinkBuilder implementation possible.

C

canBeCombinedWith(TemplateVariable.VariableType) - Method in enum org.springframework.hateoas.TemplateVariable.VariableType
 
canRead(Class<?>, MediaType) - Method in class org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
 
canRead(Type, Class<?>, MediaType) - Method in class org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
 
canWrite(Class<?>, MediaType) - Method in class org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
 
concat(TemplateVariable...) - Method in class org.springframework.hateoas.TemplateVariables
Concatenates the given TemplateVariables to the current one.
concat(Collection<TemplateVariable>) - Method in class org.springframework.hateoas.TemplateVariables
Concatenates the given TemplateVariables to the current one.
concat(TemplateVariables) - Method in class org.springframework.hateoas.TemplateVariables
Concatenates the given TemplateVariables to the current one.
ControllerEntityLinks - Class in org.springframework.hateoas.core
EntityLinks implementation which assumes a certain URI mapping structure: A class-level mapping annotation that can contain template variables.
ControllerEntityLinks(Iterable<? extends Class<?>>, LinkBuilderFactory<? extends LinkBuilder>) - Constructor for class org.springframework.hateoas.core.ControllerEntityLinks
Creates a new ControllerEntityLinks inspecting the configured classes for the given annotation.
ControllerEntityLinksFactoryBean - Class in org.springframework.hateoas.core
FactoryBean implementation to create ControllerEntityLinks instances looking up controller classes from an ApplicationContext.
ControllerEntityLinksFactoryBean() - Constructor for class org.springframework.hateoas.core.ControllerEntityLinksFactoryBean
 
ControllerLinkBuilder - Class in org.springframework.hateoas.mvc
Builder to ease building Link instances pointing to Spring MVC controllers.
ControllerLinkBuilderFactory - Class in org.springframework.hateoas.mvc
Factory for LinkBuilderSupport instances based on the request mapping annotated on the given controller.
ControllerLinkBuilderFactory() - Constructor for class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
 
ControllerRelProvider - Class in org.springframework.hateoas.mvc
 
ControllerRelProvider(Class<?>, PluginRegistry<RelProvider, Class<?>>) - Constructor for class org.springframework.hateoas.mvc.ControllerRelProvider
 
ConverterRegisteringWebMvcConfigurer - Class in org.springframework.hateoas.config
 
ConverterRegisteringWebMvcConfigurer() - Constructor for class org.springframework.hateoas.config.ConverterRegisteringWebMvcConfigurer
 
createContextual(SerializerProvider, BeanProperty) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
createContextual(DeserializationContext, BeanProperty) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesDeserializer
 
createContextual(SerializerProvider, BeanProperty) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
createContextual(SerializerProvider, BeanProperty) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
createInstance() - Method in class org.springframework.hateoas.core.ControllerEntityLinksFactoryBean
 
createNewInstance(UriComponentsBuilder) - Method in class org.springframework.hateoas.core.LinkBuilderSupport
Creates a new instance of the sub-class.
createNewInstance(UriComponentsBuilder) - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilder
 
createNewInstance(UriComponentsBuilder) - Method in class org.springframework.hateoas.mvc.BasicLinkBuilder
 
createNewInstance(UriComponentsBuilder) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
 
createResource(T) - Method in class org.springframework.hateoas.mvc.IdentifiableResourceAssemblerSupport
Creates a new resource and adds a self link to it consisting using the Identifiable's id.
createResource(T, Object...) - Method in class org.springframework.hateoas.mvc.IdentifiableResourceAssemblerSupport
 
createResourceWithId(Object, T, Object...) - Method in class org.springframework.hateoas.mvc.IdentifiableResourceAssemblerSupport
 
createResourceWithId(Object, T) - Method in class org.springframework.hateoas.mvc.ResourceAssemblerSupport
Creates a new resource with a self link to the given id.
createResourceWithId(Object, T, Object...) - Method in class org.springframework.hateoas.mvc.ResourceAssemblerSupport
 
Curie(String, String) - Constructor for class org.springframework.hateoas.hal.DefaultCurieProvider.Curie
 
CurieProvider - Interface in org.springframework.hateoas.hal
API to provide HAL curie information for links.

D

DefaultCurieProvider - Class in org.springframework.hateoas.hal
Default implementation of CurieProvider rendering a single configurable UriTemplate based curie.
DefaultCurieProvider(String, UriTemplate) - Constructor for class org.springframework.hateoas.hal.DefaultCurieProvider
Creates a new DefaultCurieProvider for the given name and UriTemplate.
DefaultCurieProvider(Map<String, UriTemplate>) - Constructor for class org.springframework.hateoas.hal.DefaultCurieProvider
Creates a new DefaultCurieProvider for the given curies.
DefaultCurieProvider(Map<String, UriTemplate>, String) - Constructor for class org.springframework.hateoas.hal.DefaultCurieProvider
Creates a new DefaultCurieProvider for the given curies using the one with the given name as default, which means to expand unprefixed, non-IANA link relations.
DefaultCurieProvider.Curie - Class in org.springframework.hateoas.hal
Value object to get the curie Link rendered in JSON.
DefaultRelProvider - Class in org.springframework.hateoas.core
Default implementation of RelProvider to simply use the uncapitalized version of the given type's name as single resource rel as well as an appended List for the collection resource rel.
DefaultRelProvider() - Constructor for class org.springframework.hateoas.core.DefaultRelProvider
 
DelegatingEntityLinks - Class in org.springframework.hateoas.core
EntityLinks implementation that delegates to the EntityLinks instances registered in the PluginRegistry given on instance creation.
DelegatingEntityLinks(PluginRegistry<EntityLinks, Class<?>>) - Constructor for class org.springframework.hateoas.core.DelegatingEntityLinks
Creates a new DelegatingEntityLinks using the given PluginRegistry.
DelegatingRelProvider - Class in org.springframework.hateoas.core
 
DelegatingRelProvider(PluginRegistry<RelProvider, Class<?>>) - Constructor for class org.springframework.hateoas.core.DelegatingRelProvider
 
descriptor() - Static method in class org.springframework.hateoas.alps.Alps
Returns a new DescriptorBuilder.
Descriptor - Class in org.springframework.hateoas.alps
A value object for an ALPS descriptor.
Descriptor() - Constructor for class org.springframework.hateoas.alps.Descriptor
 
deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListDeserializer
 
deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesDeserializer
 
deserializerInstance(DeserializationConfig, Annotated, Class<?>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
 
doc() - Static method in class org.springframework.hateoas.alps.Alps
Returns a new DocBuilder.
Doc - Class in org.springframework.hateoas.alps
A value object for an ALPS doc element.
Doc(String, Format) - Constructor for class org.springframework.hateoas.alps.Doc
Creates a new Doc instance with the given value and Format.
DummyInvocationUtils - Class in org.springframework.hateoas.core
Utility methods to capture dummy method invocations.
DummyInvocationUtils() - Constructor for class org.springframework.hateoas.core.DummyInvocationUtils
 
DummyInvocationUtils.LastInvocationAware - Interface in org.springframework.hateoas.core
 
DummyInvocationUtils.MethodInvocation - Interface in org.springframework.hateoas.core
 

E

EmbeddedWrapper - Interface in org.springframework.hateoas.core
A wrapper to handle values to be embedded into a Resource.
EmbeddedWrappers - Class in org.springframework.hateoas.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.core.EmbeddedWrappers
Creates a new EmbeddedWrappers.
emptyCollectionOf(Class<?>) - Method in class org.springframework.hateoas.core.EmbeddedWrappers
Creates an EmbeddedWrapper for an empty Collection with the given element type.
EnableEntityLinks - Annotation Type in org.springframework.hateoas.config
Enables the collection of LinkBuilder instances from the application context.
EnableHypermediaSupport - Annotation Type in org.springframework.hateoas.config
Activates hypermedia support in the ApplicationContext.
EnableHypermediaSupport.HypermediaType - Enum in org.springframework.hateoas.config
Hypermedia representation types supported.
encodeFragment(Object) - Static method in class org.springframework.hateoas.core.EncodingUtils
Encodes the given fragment value.
encodeParameter(Object) - Static method in class org.springframework.hateoas.core.EncodingUtils
Encodes the given request parameter value.
encodePath(Object) - Static method in class org.springframework.hateoas.core.EncodingUtils
Encodes the given path value.
EncodingUtils - Class in org.springframework.hateoas.core
Utilities for URI encoding.
EncodingUtils() - Constructor for class org.springframework.hateoas.core.EncodingUtils
 
enhance(UriComponentsBuilder, MethodParameter, Object) - Method in interface org.springframework.hateoas.mvc.UriComponentsContributor
Enhance the given UriComponentsBuilder with the given value.
EntityLinks - Interface in org.springframework.hateoas
Accessor to links pointing to controllers backing an entity type.
equals(Object) - Method in class org.springframework.hateoas.Links
 
equals(Object) - Method in class org.springframework.hateoas.PagedResources
 
equals(Object) - Method in class org.springframework.hateoas.PagedResources.PageMetadata
 
equals(Object) - Method in class org.springframework.hateoas.Resource
 
equals(Object) - Method in class org.springframework.hateoas.Resources
 
equals(Object) - Method in class org.springframework.hateoas.ResourceSupport
 
equals(Object) - Method in class org.springframework.hateoas.VndErrors
 
equals(Object) - Method in class org.springframework.hateoas.VndErrors.VndError
 
EvoInflectorRelProvider - Class in org.springframework.hateoas.core
RelProvider implementation using the Evo Inflector implementation of an algorithmic approach to English plurals.
EvoInflectorRelProvider() - Constructor for class org.springframework.hateoas.core.EvoInflectorRelProvider
 
expand(Object...) - Method in class org.springframework.hateoas.Link
Turns the current template into a Link by expanding it using the given parameters.
expand(Map<String, ? extends Object>) - Method in class org.springframework.hateoas.Link
Turns the current template into a Link by expanding it using the given parameters.
expand(Object...) - Method in class org.springframework.hateoas.UriTemplate
Expands the UriTemplate using the given parameters.
expand(Map<String, ? extends Object>) - Method in class org.springframework.hateoas.UriTemplate
Expands the UriTemplate using the given parameters.
ExposesResourceFor - Annotation Type in org.springframework.hateoas
Annotation to demarcate controllers that expose URI templates of a structure according to ControllerEntityLinks.
ext() - Static method in class org.springframework.hateoas.alps.Alps
Returns a new ExtBuilder.
Ext - Class in org.springframework.hateoas.alps
A value object for an ALPS ext element.
Ext() - Constructor for class org.springframework.hateoas.alps.Ext
 
extendMessageConverters(List<HttpMessageConverter<?>>) - Method in class org.springframework.hateoas.config.ConverterRegisteringWebMvcConfigurer
 

F

findLinksWithRel(String, String) - Method in class org.springframework.hateoas.core.JsonPathLinkDiscoverer
 
findLinksWithRel(String, InputStream) - Method in class org.springframework.hateoas.core.JsonPathLinkDiscoverer
 
findLinksWithRel(String, String) - Method in interface org.springframework.hateoas.LinkDiscoverer
Returns all links with the given relation type found in the given String representation.
findLinksWithRel(String, InputStream) - Method in interface org.springframework.hateoas.LinkDiscoverer
Returns all links with the given relation type found in the given InputStream representation.
findLinkWithRel(String, String) - Method in class org.springframework.hateoas.core.JsonPathLinkDiscoverer
 
findLinkWithRel(String, InputStream) - Method in class org.springframework.hateoas.core.JsonPathLinkDiscoverer
 
findLinkWithRel(String, String) - Method in interface org.springframework.hateoas.LinkDiscoverer
Finds a single link with the given relation type in the given String representation.
findLinkWithRel(String, InputStream) - Method in interface org.springframework.hateoas.LinkDiscoverer
Finds a single link with the given relation type in the given InputStream representation.
follow(String...) - Method in class org.springframework.hateoas.client.Traverson
Sets up a Traverson.TraversalBuilder to follow the given rels.
follow(Hop) - Method in class org.springframework.hateoas.client.Traverson
Sets up a Traverson.TraversalBuilder for a single rel with customized details.
follow(String...) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Follows the given rels one by one, which means a request per rel to discover the next resource with the rel in line.
follow(Hop) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Follows the given rels one by one, which means a request per rel to discover the next resource with the rel in line.
Format - Enum in org.springframework.hateoas.alps
Enum for all ALPS doc formats.
from(String) - Static method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns the TemplateVariable.VariableType for the given variable key.

G

getAnnotationType() - Method in class org.springframework.hateoas.core.AnnotationAttribute
Returns the annotation type.
getArguments() - Method in interface org.springframework.hateoas.core.DummyInvocationUtils.MethodInvocation
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.core.AnnotationRelProvider
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.core.DefaultRelProvider
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.core.DelegatingRelProvider
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.core.EvoInflectorRelProvider
 
getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.mvc.ControllerRelProvider
 
getCollectionResourceRelFor(Class<?>) - Method in interface org.springframework.hateoas.RelProvider
Returns the relation type to be used to point to a collection resource of the given type.
getContent() - Method in class org.springframework.hateoas.hal.ResourcesMixin
 
getContent() - Method in class org.springframework.hateoas.Resource
Returns the underlying entity.
getContent() - Method in class org.springframework.hateoas.Resources
Returns the underlying elements.
getContentDeserializer() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListDeserializer
 
getContentDeserializer() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesDeserializer
 
getContentSerializer() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
getContentSerializer() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
getContentSerializer() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
getContentType() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListDeserializer
 
getContentType() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
getContentType() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesDeserializer
 
getContentType() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
getContentType() - Method in class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
getCurieHref(String, UriTemplate) - Method in class org.springframework.hateoas.hal.DefaultCurieProvider
Returns the href for the DefaultCurieProvider.Curie instance to be created.
getCurieInformation(Links) - Method in interface org.springframework.hateoas.hal.CurieProvider
Returns an object to render as the base curie information.
getCurieInformation(Links) - Method in class org.springframework.hateoas.hal.DefaultCurieProvider
 
getDefaultMessageConverters(MediaType...) - Static method in class org.springframework.hateoas.client.Traverson
Returns all HttpMessageConverters that will be registered for the given MediaTypes by default.
getDefaultMessageConverters(List<MediaType>) - Static method in class org.springframework.hateoas.client.Traverson
Returns all HttpMessageConverters that will be registered for the given MediaTypes by default.
getId() - Method in interface org.springframework.hateoas.Identifiable
Returns the id identifying the object.
getId() - Method in class org.springframework.hateoas.ResourceSupport
Returns the Link with a rel of Link.REL_SELF.
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.core.AnnotationRelProvider
 
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.core.DefaultRelProvider
 
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.core.DelegatingRelProvider
 
getItemResourceRelFor(Class<?>) - Method in class org.springframework.hateoas.mvc.ControllerRelProvider
 
getItemResourceRelFor(Class<?>) - Method in interface org.springframework.hateoas.RelProvider
Returns the relation type to be used to point to an item resource of the given type.
getLastInvocation() - Method in interface org.springframework.hateoas.core.DummyInvocationUtils.LastInvocationAware
 
getLink(String) - Method in class org.springframework.hateoas.Links
Returns the Link with the given rel.
getLink(String) - Method in class org.springframework.hateoas.ResourceSupport
Returns the link with the given rel.
getLinkDiscovererFor(MediaType) - Method in class org.springframework.hateoas.LinkDiscoverers
Returns the LinkDiscoverer suitable for the given MediaType.
getLinkDiscovererFor(String) - Method in class org.springframework.hateoas.LinkDiscoverers
Returns the LinkDiscoverer suitable for the given media type.
getLinks(String) - Method in class org.springframework.hateoas.Links
Returns all Links with the given relation type.
getLinks() - Method in class org.springframework.hateoas.ResourceSupport
Returns all Links contained in this resource.
getLinks(String) - Method in class org.springframework.hateoas.ResourceSupport
Returns all Links with the given relation type.
getLogref() - Method in class org.springframework.hateoas.VndErrors.VndError
Returns the logref of the error.
getMapping(Class<?>) - Method in class org.springframework.hateoas.core.AnnotationMappingDiscoverer
 
getMapping(Method) - Method in class org.springframework.hateoas.core.AnnotationMappingDiscoverer
 
getMapping(Class<?>, Method) - Method in class org.springframework.hateoas.core.AnnotationMappingDiscoverer
 
getMapping(Class<?>) - Method in interface org.springframework.hateoas.core.MappingDiscoverer
Returns the mapping associated with the given type.
getMapping(Method) - Method in interface org.springframework.hateoas.core.MappingDiscoverer
Returns the mapping associated with the given Method.
getMapping(Class<?>, Method) - Method in interface org.springframework.hateoas.core.MappingDiscoverer
Returns the mapping for the given Method invoked on the given type.
getMessage() - Method in class org.springframework.hateoas.VndErrors.VndError
Returns the message of the error.
getMetadata() - Method in class org.springframework.hateoas.PagedResources
Returns the pagination metadata.
getMethod() - Method in interface org.springframework.hateoas.core.DummyInvocationUtils.MethodInvocation
 
getName() - Method in class org.springframework.hateoas.hal.DefaultCurieProvider.Curie
 
getNamespacedRelFor(String) - Method in interface org.springframework.hateoas.hal.CurieProvider
Returns the rel to be rendered for the given rel.
getNamespacedRelFor(String) - Method in class org.springframework.hateoas.hal.DefaultCurieProvider
 
getNamespacedRelFrom(Link) - Method in interface org.springframework.hateoas.hal.CurieProvider
Returns the rel to be rendered for the given Link.
getNamespacedRelFrom(Link) - Method in class org.springframework.hateoas.hal.DefaultCurieProvider
 
getNextLink() - Method in class org.springframework.hateoas.PagedResources
Returns the Link pointing to the next page (if set).
getNumber() - Method in class org.springframework.hateoas.PagedResources.PageMetadata
Returns the number of the current page.
getObjectParameters() - Method in interface org.springframework.hateoas.core.DummyInvocationUtils.LastInvocationAware
 
getObjectType() - Method in class org.springframework.hateoas.core.ControllerEntityLinksFactoryBean
 
getParameter(String) - Method in class org.springframework.hateoas.core.MethodParameters
Returns the MethodParameter with the given name or null if none found.
getParameters() - Method in class org.springframework.hateoas.core.MethodParameters
Returns all MethodParameters.
getParametersOfType(Class<?>) - Method in class org.springframework.hateoas.core.MethodParameters
Returns all parameters of the given type.
getParametersWith(Class<? extends Annotation>) - Method in class org.springframework.hateoas.core.MethodParameters
Returns all MethodParameters annotated with the given annotation type.
getPreviousLink() - Method in class org.springframework.hateoas.PagedResources
Returns the Link pointing to the previous page (if set).
getRel() - Method in interface org.springframework.hateoas.core.EmbeddedWrapper
Returns the rel to be used when embedding.
getRelTargetType() - Method in interface org.springframework.hateoas.core.EmbeddedWrapper
Returns the type to be used to calculate a type based rel.
getSchema(SerializerProvider, Type) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
getSize() - Method in class org.springframework.hateoas.PagedResources.PageMetadata
Returns the requested size of the page.
getTargetType() - Method in interface org.springframework.hateoas.core.DummyInvocationUtils.MethodInvocation
 
getThis() - Method in class org.springframework.hateoas.core.LinkBuilderSupport
Returns the current concrete instance.
getThis() - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilder
 
getThis() - Method in class org.springframework.hateoas.mvc.BasicLinkBuilder
 
getThis() - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
 
getTotalElements() - Method in class org.springframework.hateoas.PagedResources.PageMetadata
Returns the total number of elements available.
getTotalPages() - Method in class org.springframework.hateoas.PagedResources.PageMetadata
Returns how many pages are available in total.
getValue() - Method in interface org.springframework.hateoas.core.EmbeddedWrapper
Returns the actual value to embed.
getValueFrom(MethodParameter) - Method in class org.springframework.hateoas.core.AnnotationAttribute
Reads the Annotation attribute's value from the given MethodParameter.
getValueFrom(AnnotatedElement) - Method in class org.springframework.hateoas.core.AnnotationAttribute
Reads the Annotation attribute's value from the given AnnotatedElement.
getValueFrom(Annotation) - Method in class org.springframework.hateoas.core.AnnotationAttribute
Returns the Annotation attribute's value from the given Annotation.
getVariableNames() - Method in class org.springframework.hateoas.Link
Returns the variable names contained in the template.
getVariableNames() - Method in class org.springframework.hateoas.UriTemplate
Returns the names of the variables discovered.
getVariables() - Method in class org.springframework.hateoas.Link
Returns all TemplateVariables contained in the Link.
getVariables() - Method in class org.springframework.hateoas.UriTemplate
Returns the TemplateVariables discovered.

H

HAL_JSON - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/hal+json.
HAL_JSON_UTF8 - Static variable in class org.springframework.hateoas.MediaTypes
Public constant media type for application/hal+json;charset=UTF-8.
HAL_JSON_UTF8_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.HAL_JSON_UTF8.
HAL_JSON_VALUE - Static variable in class org.springframework.hateoas.MediaTypes
A String equivalent of MediaTypes.HAL_JSON.
HalConfiguration - Class in org.springframework.hateoas.hal
 
HalConfiguration() - Constructor for class org.springframework.hateoas.hal.HalConfiguration
 
HalConfiguration.RenderSingleLinks - Enum in org.springframework.hateoas.hal
 
HalHandlerInstantiator(RelProvider, CurieProvider, MessageSourceAccessor, AutowireCapableBeanFactory, HalConfiguration) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
HalHandlerInstantiator(RelProvider, CurieProvider, MessageSourceAccessor, AutowireCapableBeanFactory) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
 
HalHandlerInstantiator(RelProvider, CurieProvider, MessageSourceAccessor) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
 
HalHandlerInstantiator(RelProvider, CurieProvider, MessageSourceAccessor, HalConfiguration) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
HalHandlerInstantiator(RelProvider, CurieProvider, MessageSourceAccessor, boolean, HalConfiguration) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
Creates a new Jackson2HalModule.HalHandlerInstantiator using the given RelProvider, CurieProvider and MessageSourceAccessor and whether to enforce embedded collections.
HalLinkDiscoverer - Class in org.springframework.hateoas.hal
LinkDiscoverer implementation based on HAL link structure.
HalLinkDiscoverer() - Constructor for class org.springframework.hateoas.hal.HalLinkDiscoverer
 
HalLinkListDeserializer() - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListDeserializer
 
HalLinkListSerializer(CurieProvider, Jackson2HalModule.EmbeddedMapper, MessageSourceAccessor, HalConfiguration) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
HalLinkListSerializer(BeanProperty, CurieProvider, Jackson2HalModule.EmbeddedMapper, MessageSourceAccessor, HalConfiguration) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
HalResourcesDeserializer() - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesDeserializer
 
HalResourcesDeserializer(JavaType) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesDeserializer
 
HalResourcesSerializer(Jackson2HalModule.EmbeddedMapper) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
HalResourcesSerializer(BeanProperty, Jackson2HalModule.EmbeddedMapper) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.hateoas.mvc.ResourceProcessorHandlerMethodReturnValueHandler
 
hasDescription() - Method in class org.springframework.hateoas.TemplateVariable
Returns whether the variable has a description.
hashCode() - Method in class org.springframework.hateoas.Links
 
hashCode() - Method in class org.springframework.hateoas.PagedResources
 
hashCode() - Method in class org.springframework.hateoas.PagedResources.PageMetadata
 
hashCode() - Method in class org.springframework.hateoas.Resource
 
hashCode() - Method in class org.springframework.hateoas.Resources
 
hashCode() - Method in class org.springframework.hateoas.ResourceSupport
 
hashCode() - Method in class org.springframework.hateoas.VndErrors
 
hashCode() - Method in class org.springframework.hateoas.VndErrors.VndError
 
hasLink(String) - Method in class org.springframework.hateoas.Links
Returns whether the Links container contains a Link with the given rel.
hasLink(String) - Method in class org.springframework.hateoas.ResourceSupport
Returns whether the resource contains a Link with the given rel.
hasLinks() - Method in class org.springframework.hateoas.ResourceSupport
Returns whether the resource contains Links at all.
hasRel(String) - Method in interface org.springframework.hateoas.core.EmbeddedWrapper
Returns whether the wrapper has the given rel.
hasSingleElement(List<Link>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
hasSingleElement(Collection<?>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
hasSingleElement(Object) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
HeaderLinksResponseEntity<T extends ResourceSupport> - Class in org.springframework.hateoas.mvc
Special ResponseEntity that exposes Link instances in the contained ResourceSupport as link headers instead of in the body.
Hop - Class in org.springframework.hateoas.client
Container for customizations to a single traverson "hop"
Hop() - Constructor for class org.springframework.hateoas.client.Hop
 

I

IanaRels - Class in org.springframework.hateoas
Static class to find out whether a relation type is defined by the IANA.
IanaRels() - Constructor for class org.springframework.hateoas.IanaRels
 
Identifiable<ID extends Serializable> - Interface in org.springframework.hateoas
Interface to mark objects that are identifiable by an ID of any type.
IdentifiableResourceAssemblerSupport<T extends Identifiable<?>,D extends ResourceSupport> - Class in org.springframework.hateoas.mvc
Base class to implement ResourceAssemblers.
IdentifiableResourceAssemblerSupport(Class<?>, Class<D>) - Constructor for class org.springframework.hateoas.mvc.IdentifiableResourceAssemblerSupport
Creates a new ResourceAssemblerSupport using the given controller class and resource type.
instantiateResource(T) - Method in class org.springframework.hateoas.mvc.ResourceAssemblerSupport
Instantiates the resource object.
invokeProcessorsFor(T) - Method in class org.springframework.hateoas.mvc.ResourceProcessorInvoker
Invokes all ResourceProcessor instances registered for the type of the given value.
invokeProcessorsFor(T, ResolvableType) - Method in class org.springframework.hateoas.mvc.ResourceProcessorInvoker
Invokes all ResourceProcessor instances registered for the type of the given value and reference type.
isAlreadyRegisteredIn(ObjectMapper) - Static method in class org.springframework.hateoas.hal.Jackson2HalModule
Returns whether the module was already registered in the given ObjectMapper.
isCollectionValue() - Method in interface org.springframework.hateoas.core.EmbeddedWrapper
Returns whether the wrapper is a collection value.
isEmpty(SerializerProvider, List<Link>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
isEmpty(SerializerProvider, Collection<?>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
isEmpty(SerializerProvider, Object) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
isEmpty(SerializerProvider, Boolean) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
isEmpty() - Method in class org.springframework.hateoas.Links
Returns whether the Links container is empty.
isIanaRel(String) - Static method in class org.springframework.hateoas.IanaRels
Returns whether the given relation type is defined by the IANA.
isOptional() - Method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns whether the variable of this type is optional.
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 the link is templated.
iterator() - Method in class org.springframework.hateoas.Links
 
iterator() - Method in class org.springframework.hateoas.Resources
 
iterator() - Method in class org.springframework.hateoas.TemplateVariables
 
iterator() - Method in class org.springframework.hateoas.UriTemplate
 
iterator() - Method in class org.springframework.hateoas.VndErrors
 

J

Jackson2HalModule - Class in org.springframework.hateoas.hal
Jackson 2 module implementation to render Link and ResourceSupport instances in HAL compatible JSON.
Jackson2HalModule() - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule
 
Jackson2HalModule.HalHandlerInstantiator - Class in org.springframework.hateoas.hal
HandlerInstantiator to create HAL-specific serializers, deserializers etc.
Jackson2HalModule.HalLinkListDeserializer - Class in org.springframework.hateoas.hal
 
Jackson2HalModule.HalLinkListSerializer - Class in org.springframework.hateoas.hal
Custom JsonSerializer to render Link instances in HAL compatible JSON.
Jackson2HalModule.HalResourcesDeserializer - Class in org.springframework.hateoas.hal
 
Jackson2HalModule.HalResourcesSerializer - Class in org.springframework.hateoas.hal
Custom JsonSerializer to render Resource-Lists in HAL compatible JSON.
Jackson2HalModule.OptionalListJackson2Serializer - Class in org.springframework.hateoas.hal
Custom JsonSerializer to render Link instances in HAL compatible JSON.
Jackson2HalModule.TrueOnlyBooleanSerializer - Class in org.springframework.hateoas.hal
JsonSerializer to only render Boolean values if they're set to true.
JaxRsLinkBuilder - Class in org.springframework.hateoas.jaxrs
LinkBuilder to derive URI mappings from a JAX-RS Path annotation.
JaxRsLinkBuilderFactory - Class in org.springframework.hateoas.jaxrs
Factory for LinkBuilder instances based on the path mapping annotated on the given JAX-RS service.
JaxRsLinkBuilderFactory() - Constructor for class org.springframework.hateoas.jaxrs.JaxRsLinkBuilderFactory
 
JsonPathLinkDiscoverer - Class in org.springframework.hateoas.core
LinkDiscoverer that uses JsonPath to find links inside a representation.
JsonPathLinkDiscoverer(String, MediaType, MediaType...) - Constructor for class org.springframework.hateoas.core.JsonPathLinkDiscoverer
Creates a new JsonPathLinkDiscoverer using the given path template supporting the given MediaType.

K

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

L

Link - Class in org.springframework.hateoas
Value object for links.
Link(String) - Constructor for class org.springframework.hateoas.Link
Creates a new link to the given URI with the self rel.
Link(String, String) - Constructor for class org.springframework.hateoas.Link
Creates a new Link to the given URI with the given rel.
Link(UriTemplate, String) - Constructor for class org.springframework.hateoas.Link
Creates a new Link from the given UriTemplate and rel.
LinkBuilder - Interface in org.springframework.hateoas
Builder to ease building Link instances.
LinkBuilderFactory<T extends LinkBuilder> - Interface in org.springframework.hateoas
Factory for LinkBuilder instances.
LinkBuilderSupport<T extends LinkBuilder> - Class in org.springframework.hateoas.core
Base class to implement LinkBuilders based on a Spring MVC UriComponentsBuilder.
LinkBuilderSupport(UriComponentsBuilder) - Constructor for class org.springframework.hateoas.core.LinkBuilderSupport
Creates a new LinkBuilderSupport using the given UriComponentsBuilder.
LinkBuilderSupport(UriComponents) - Constructor for class org.springframework.hateoas.core.LinkBuilderSupport
Creates a new LinkBuilderSupport using the given UriComponents.
LinkDiscoverer - Interface in org.springframework.hateoas
Interface to allow discovering links by relation type from some source.
LinkDiscoverers - Class in org.springframework.hateoas
Value object to wrap a PluginRegistry for LinkDiscoverer so that it's easier to inject them into clients wanting to lookup a LinkDiscoverer for a given MediaTypes.
LinkDiscoverers(PluginRegistry<LinkDiscoverer, MediaType>) - Constructor for class org.springframework.hateoas.LinkDiscoverers
Creates a new LinkDiscoverers instance with the given PluginRegistry.
linkFor(Class<?>) - Method in class org.springframework.hateoas.core.ControllerEntityLinks
 
linkFor(Class<?>, Object...) - Method in class org.springframework.hateoas.core.ControllerEntityLinks
 
linkFor(Class<?>) - Method in class org.springframework.hateoas.core.DelegatingEntityLinks
 
linkFor(Class<?>, Object...) - Method in class org.springframework.hateoas.core.DelegatingEntityLinks
 
linkFor(Class<?>) - Method in interface org.springframework.hateoas.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity type.
linkFor(Class<?>, Object...) - Method in interface org.springframework.hateoas.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity type, unfolding the given parameters into the URI template the backing controller is mapped to.
linkForSingleResource(Class<?>, Object) - Method in class org.springframework.hateoas.core.AbstractEntityLinks
 
linkForSingleResource(Identifiable<?>) - Method in class org.springframework.hateoas.core.AbstractEntityLinks
 
linkForSingleResource(Class<?>, Object) - Method in interface org.springframework.hateoas.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity type and id.
linkForSingleResource(Identifiable<?>) - Method in interface org.springframework.hateoas.EntityLinks
Returns a LinkBuilder able to create links to the controller managing the given entity.
Links - Class in org.springframework.hateoas
Value object to represent a list of Links.
Links(List<Link>) - Constructor for class org.springframework.hateoas.Links
Creates a new Links instance from the given Links.
Links(Link...) - Constructor for class org.springframework.hateoas.Links
Creates a new Links instance from the given Links.
linkTo(Class<?>) - Static method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilder
Creates a JaxRsLinkBuilder instance to link to the Path mapping tied to the given class.
linkTo(Class<?>, Object...) - Static method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilder
Creates a new JaxRsLinkBuilder instance to link to the Path mapping tied to the given class binding the given parameters to the URI template.
linkTo(Class<?>, Map<String, ?>) - Static method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilder
Creates a new JaxRsLinkBuilder instance to link to the Path mapping tied to the given class binding the given parameters to the URI template.
linkTo(Class<?>) - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilderFactory
 
linkTo(Class<?>, Object...) - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilderFactory
 
linkTo(Class<?>, Map<String, ?>) - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilderFactory
 
linkTo(Class<?>) - Method in interface org.springframework.hateoas.LinkBuilderFactory
Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
linkTo(Class<?>, Object...) - Method in interface org.springframework.hateoas.LinkBuilderFactory
Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
linkTo(Class<?>, Map<String, ?>) - Method in interface org.springframework.hateoas.LinkBuilderFactory
Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
linkTo(Method, Object...) - Method in interface org.springframework.hateoas.MethodLinkBuilderFactory
Returns a LinkBuilder pointing to the URI mapped to the given Method and expanding this mapping using the given parameters.
linkTo(Class<?>, Method, Object...) - Method in interface org.springframework.hateoas.MethodLinkBuilderFactory
Returns a LinkBuilder pointing to the URI mapped to the given Method assuming it was invoked on an object of the given type.
linkTo(Object) - Method in interface org.springframework.hateoas.MethodLinkBuilderFactory
Returns a LinkBuilder pointing to the URI mapped to the method the result is handed into this method.
linkTo(Class<?>) - Static method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Class<?>, Object...) - Static method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Class<?>, Map<String, ?>) - Static method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
linkTo(Method, Object...) - Static method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
 
linkTo(Class<?>, Method, Object...) - Static method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
 
linkTo(Object) - Static method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Creates a ControllerLinkBuilder pointing to a controller method.
linkTo(Class<?>) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
 
linkTo(Class<?>, Object...) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
 
linkTo(Class<?>, Map<String, ?>) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
 
linkTo(Class<?>, Method, Object...) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
 
linkTo(Object) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
 
linkTo(Method, Object...) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
 
linkToCollectionResource(Class<?>) - Method in class org.springframework.hateoas.core.ControllerEntityLinks
 
linkToCollectionResource(Class<?>) - Method in class org.springframework.hateoas.core.DelegatingEntityLinks
 
linkToCollectionResource(Class<?>) - Method in interface org.springframework.hateoas.EntityLinks
Creates a Link pointing to the collection resource of the given type.
linkToCurrentMapping() - Static method in class org.springframework.hateoas.mvc.BasicLinkBuilder
Creates a new BasicLinkBuilder to link to the current servlet mapping.
linkToSingleResource(Identifiable<?>) - Method in class org.springframework.hateoas.core.AbstractEntityLinks
 
linkToSingleResource(Class<?>, Object) - Method in class org.springframework.hateoas.core.ControllerEntityLinks
 
linkToSingleResource(Class<?>, Object) - Method in class org.springframework.hateoas.core.DelegatingEntityLinks
 
linkToSingleResource(Class<?>, Object) - Method in interface org.springframework.hateoas.EntityLinks
Creates a Link pointing to single resource backing the given entity type and id.
linkToSingleResource(Identifiable<?>) - Method in interface org.springframework.hateoas.EntityLinks
Creates a Link pointing to single resource backing the given entity.

M

MappingDiscoverer - Interface in org.springframework.hateoas.core
Strategy interface to discover a URI mapping for either a given type or method.
MediaTypes - Class in org.springframework.hateoas
Constants for well-known hypermedia types.
MediaTypes() - Constructor for class org.springframework.hateoas.MediaTypes
 
MethodLinkBuilderFactory<T extends LinkBuilder> - Interface in org.springframework.hateoas
Extension of LinkBuilderFactory for implementations that also support creating LinkBuilders by pointing to a method.
methodOn(Class<T>, Object...) - Static method in class org.springframework.hateoas.core.DummyInvocationUtils
Returns a proxy of the given type, backed by an EmptyTargetSource to simply drop method invocations but equips it with an InvocationRecordingMethodInterceptor.
methodOn(Class<T>, Object...) - Static method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of ControllerLinkBuilder.
MethodParameters - Class in org.springframework.hateoas.core
Value object to represent MethodParameters to allow to easily find the ones with a given annotation.
MethodParameters(Method) - Constructor for class org.springframework.hateoas.core.MethodParameters
Creates a new MethodParameters from the given Method.
MethodParameters(Method, AnnotationAttribute) - Constructor for class org.springframework.hateoas.core.MethodParameters
Creates a new MethodParameters for the given Method and AnnotationAttribute.

N

NO_PAGE - Static variable in class org.springframework.hateoas.PagedResources
 
NO_RELATION - Static variable in annotation type org.springframework.hateoas.core.Relation
 
NONE - Static variable in class org.springframework.hateoas.TemplateVariables
 

O

OptionalListJackson2Serializer() - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
OptionalListJackson2Serializer(BeanProperty) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
OptionalListJackson2Serializer(BeanProperty, HalConfiguration) - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
Creates a new Jackson2HalModule.OptionalListJackson2Serializer using the given BeanProperty.
org.springframework.hateoas - package org.springframework.hateoas
Value objects to ease creating Links and link driven representations for REST webservices.
org.springframework.hateoas.alps - package org.springframework.hateoas.alps
Value objects to build ALPS metadata.
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.core - package org.springframework.hateoas.core
Implementations of core API interfaces.
org.springframework.hateoas.hal - package org.springframework.hateoas.hal
HAL-specific extensions, SPIs and Jackson customizations.
org.springframework.hateoas.jaxrs - package org.springframework.hateoas.jaxrs
LinkBuilder implementations to consider JAX-RS annotations.
org.springframework.hateoas.mvc - package org.springframework.hateoas.mvc
Spring MVC helper classes to build Links and assemble ResourceSupport types.

P

PagedResources<T> - Class in org.springframework.hateoas
DTO to implement binding response representations of pageable collections.
PagedResources() - Constructor for class org.springframework.hateoas.PagedResources
Default constructor to allow instantiation by reflection.
PagedResources(Collection<T>, PagedResources.PageMetadata, Link...) - Constructor for class org.springframework.hateoas.PagedResources
Creates a new PagedResources from the given content, PagedResources.PageMetadata and Links (optional).
PagedResources(Collection<T>, PagedResources.PageMetadata, Iterable<Link>) - Constructor for class org.springframework.hateoas.PagedResources
Creates a new PagedResources from the given content PagedResources.PageMetadata and Links.
PagedResources.PageMetadata - Class in org.springframework.hateoas
Value object for pagination metadata.
PagedResourcesType() - Constructor for class org.springframework.hateoas.mvc.TypeReferences.PagedResourcesType
 
PageMetadata() - Constructor for class org.springframework.hateoas.PagedResources.PageMetadata
 
PageMetadata(long, long, long, long) - Constructor for class org.springframework.hateoas.PagedResources.PageMetadata
Creates a new PagedResources.PageMetadata from the given size, number, total elements and total pages.
PageMetadata(long, long, long) - Constructor for class org.springframework.hateoas.PagedResources.PageMetadata
Creates a new PagedResources.PageMetadata from the given size, number and total elements.
process(T) - Method in interface org.springframework.hateoas.ResourceProcessor
Processes the given resource, add links, alter the domain data etc.

R

rel(String) - Static method in class org.springframework.hateoas.client.Hop
Creates a new Hop for the given relation name.
REL_FIRST - Static variable in class org.springframework.hateoas.Link
 
REL_LAST - Static variable in class org.springframework.hateoas.Link
 
REL_NEXT - Static variable in class org.springframework.hateoas.Link
 
REL_PREVIOUS - Static variable in class org.springframework.hateoas.Link
 
REL_SELF - Static variable in class org.springframework.hateoas.Link
 
Relation - Annotation Type in org.springframework.hateoas.core
Annotation to configure the relation to be used when embedding objects in HAL representations of Resources and Resources.
RelProvider - Interface in org.springframework.hateoas
API to provide relation types for collections and items of the given type.
removeLinks() - Method in class org.springframework.hateoas.ResourceSupport
Removes all Links added to the resource so far.
Resource<T> - Class in org.springframework.hateoas
A simple Resource wrapping a domain object and adding links to it.
Resource(T, Link...) - Constructor for class org.springframework.hateoas.Resource
Creates a new Resource with the given content and Links (optional).
Resource(T, Iterable<Link>) - Constructor for class org.springframework.hateoas.Resource
Creates a new Resource with the given content and Links.
ResourceAssembler<T,D extends ResourceSupport> - Interface in org.springframework.hateoas
Interface for components that convert a domain type into an ResourceSupport.
ResourceAssemblerSupport<T,D extends ResourceSupport> - Class in org.springframework.hateoas.mvc
Base class to implement ResourceAssemblers.
ResourceAssemblerSupport(Class<?>, Class<D>) - Constructor for class org.springframework.hateoas.mvc.ResourceAssemblerSupport
Creates a new ResourceAssemblerSupport using the given controller class and resource type.
ResourceProcessor<T extends ResourceSupport> - Interface in org.springframework.hateoas
SPI interface to allow components to process the ResourceSupport instances returned from Spring MVC controllers.
ResourceProcessorHandlerMethodReturnValueHandler - Class in org.springframework.hateoas.mvc
HandlerMethodReturnValueHandler to post-process the objects returned from controller methods using the configured ResourceProcessors.
ResourceProcessorHandlerMethodReturnValueHandler() - Constructor for class org.springframework.hateoas.mvc.ResourceProcessorHandlerMethodReturnValueHandler
 
ResourceProcessorInvoker - Class in org.springframework.hateoas.mvc
Component to easily invoke all ResourceProcessor instances registered for values of type ResourceSupport.
ResourceProcessorInvoker(Collection<ResourceProcessor<?>>) - Constructor for class org.springframework.hateoas.mvc.ResourceProcessorInvoker
Creates a new ResourceProcessorInvoker to consider the given ResourceProcessor to post-process the controller methods return value to before invoking the delegate.
ResourceProcessorInvoker.ResourcesProcessorWrapper - Class in org.springframework.hateoas.mvc
ProcessorWrapper for ResourceProcessors targeting Resources.
ResourceProcessorInvokingHandlerAdapter - Class in org.springframework.hateoas.mvc
Special RequestMappingHandlerAdapter that tweaks the HandlerMethodReturnValueHandlerComposite to be proxied by a ResourceProcessorHandlerMethodReturnValueHandler which will invoke the ResourceProcessor s found in the application context and eventually delegate to the originally configured HandlerMethodReturnValueHandler.
ResourceProcessorInvokingHandlerAdapter() - Constructor for class org.springframework.hateoas.mvc.ResourceProcessorInvokingHandlerAdapter
 
Resources<T> - Class in org.springframework.hateoas
General helper to easily create a wrapper for a collection of entities.
Resources() - Constructor for class org.springframework.hateoas.Resources
Creates an empty Resources instance.
Resources(Iterable<T>, Link...) - Constructor for class org.springframework.hateoas.Resources
Creates a Resources instance with the given content and Links (optional).
Resources(Iterable<T>, Iterable<Link>) - Constructor for class org.springframework.hateoas.Resources
Creates a Resources instance with the given content and Links.
ResourcesMixin<T> - Class in org.springframework.hateoas.hal
 
ResourcesMixin() - Constructor for class org.springframework.hateoas.hal.ResourcesMixin
 
ResourcesProcessorWrapper(ResourceProcessor<?>) - Constructor for class org.springframework.hateoas.mvc.ResourceProcessorInvoker.ResourcesProcessorWrapper
ResourcesType() - Constructor for class org.springframework.hateoas.mvc.TypeReferences.ResourcesType
 
ResourceSupport - Class in org.springframework.hateoas
Base class for DTOs to collect links.
ResourceSupport() - Constructor for class org.springframework.hateoas.ResourceSupport
 
ResourceType() - Constructor for class org.springframework.hateoas.mvc.TypeReferences.ResourceType
 

S

serialize(List<Link>, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalLinkListSerializer
 
serialize(Collection<?>, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalResourcesSerializer
 
serialize(Object, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.OptionalListJackson2Serializer
 
serialize(Boolean, JsonGenerator, SerializerProvider) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
serializerInstance(SerializationConfig, Annotated, Class<?>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
 
setAnnotation(Class<? extends Annotation>) - Method in class org.springframework.hateoas.core.ControllerEntityLinksFactoryBean
Configures the annotation type to inspect the ApplicationContext for beans that carry the given annotation.
setApplicationContext(ApplicationContext) - Method in class org.springframework.hateoas.core.ControllerEntityLinksFactoryBean
 
setBeanFactory(BeanFactory) - Method in class org.springframework.hateoas.config.ConverterRegisteringWebMvcConfigurer
 
setHypermediaTypes(Collection<EnableHypermediaSupport.HypermediaType>) - Method in class org.springframework.hateoas.config.ConverterRegisteringWebMvcConfigurer
 
setLinkBuilderFactory(LinkBuilderFactory<? extends LinkBuilder>) - Method in class org.springframework.hateoas.core.ControllerEntityLinksFactoryBean
Configures the LinkBuilderFactory to be used to create LinkBuilder instances.
setLinkDiscoverers(List<? extends LinkDiscoverer>) - Method in class org.springframework.hateoas.client.Traverson
Sets the LinkDiscoverers to use.
setRestOperations(RestOperations) - Method in class org.springframework.hateoas.client.Traverson
Configures the RestOperations to use.
setRootLinksAsHeaders(boolean) - Method in class org.springframework.hateoas.mvc.ResourceProcessorHandlerMethodReturnValueHandler
 
setUriComponentsContributors(List<? extends UriComponentsContributor>) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory
Configures the UriComponentsContributor to be used when building Link instances from method invocations.
slash(Object) - Method in class org.springframework.hateoas.core.LinkBuilderSupport
 
slash(UriComponents, boolean) - Method in class org.springframework.hateoas.core.LinkBuilderSupport
 
slash(Identifiable<?>) - Method in class org.springframework.hateoas.core.LinkBuilderSupport
 
slash(Object) - Method in interface org.springframework.hateoas.LinkBuilder
Adds the given object's String representation as sub-resource to the current URI.
slash(Identifiable<?>) - Method in interface org.springframework.hateoas.LinkBuilder
Adds the given Identifiable's id as sub-resource.
supports(Class<?>) - Method in class org.springframework.hateoas.core.AnnotationRelProvider
 
supports(Class<?>) - Method in class org.springframework.hateoas.core.ControllerEntityLinks
 
supports(Class<?>) - Method in class org.springframework.hateoas.core.DefaultRelProvider
 
supports(Class<?>) - Method in class org.springframework.hateoas.core.DelegatingEntityLinks
 
supports(Class<?>) - Method in class org.springframework.hateoas.core.DelegatingRelProvider
 
supports(MediaType) - Method in class org.springframework.hateoas.core.JsonPathLinkDiscoverer
 
supports(Class<?>) - Method in class org.springframework.hateoas.mvc.ControllerRelProvider
 
supports(ResolvableType, Object) - Method in class org.springframework.hateoas.mvc.ResourceProcessorInvoker.ResourcesProcessorWrapper
 
supportsParameter(MethodParameter) - Method in interface org.springframework.hateoas.mvc.UriComponentsContributor
Returns whether the UriComponentsBuilder supports the given MethodParameter.
supportsReturnType(MethodParameter) - Method in class org.springframework.hateoas.mvc.ResourceProcessorHandlerMethodReturnValueHandler
 

T

TemplateVariable - Class in org.springframework.hateoas
A single template variable.
TemplateVariable(String, TemplateVariable.VariableType) - Constructor for class org.springframework.hateoas.TemplateVariable
Creates a new TemplateVariable with the given name and type.
TemplateVariable(String, TemplateVariable.VariableType, String) - Constructor for class org.springframework.hateoas.TemplateVariable
Creates a new TemplateVariable with the given name, type and description.
TemplateVariable.VariableType - Enum in org.springframework.hateoas
An enumeration for all supported variable types.
TemplateVariables - Class in org.springframework.hateoas
Wrapper type for a collection of TemplateVariable.
TemplateVariables(TemplateVariable...) - Constructor for class org.springframework.hateoas.TemplateVariables
Creates a new TemplateVariables for the given TemplateVariables.
TemplateVariables(List<TemplateVariable>) - Constructor for class org.springframework.hateoas.TemplateVariables
Creates a new TemplateVariables for the given TemplateVariables.
toEntity(Class<T>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Returns the raw ResponseEntity with the representation unmarshalled into an instance of the given type.
toObject(Class<T>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Executes the traversal and marshals the final response into an object of the given type.
toObject(ParameterizedTypeReference<T>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Executes the traversal and marshals the final response into an object of the given ParameterizedTypeReference.
toObject(String) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Executes the traversal and returns the result of the given JSON Path expression evaluated against the final representation.
toResource(T) - Method in interface org.springframework.hateoas.ResourceAssembler
Converts the given entity into an ResourceSupport.
toResources(Iterable<? extends T>) - Method in class org.springframework.hateoas.mvc.ResourceAssemblerSupport
Converts all given entities into resources.
toString() - Method in enum org.springframework.hateoas.alps.Format
 
toString() - Method in enum org.springframework.hateoas.alps.Type
 
toString() - Method in class org.springframework.hateoas.core.LinkBuilderSupport
 
toString() - Method in class org.springframework.hateoas.Link
 
toString() - Method in class org.springframework.hateoas.Links
 
toString() - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
 
toString() - Method in class org.springframework.hateoas.PagedResources.PageMetadata
 
toString() - Method in class org.springframework.hateoas.PagedResources
 
toString() - Method in class org.springframework.hateoas.Resource
 
toString() - Method in class org.springframework.hateoas.Resources
 
toString() - Method in class org.springframework.hateoas.ResourceSupport
 
toString() - Method in class org.springframework.hateoas.TemplateVariable
 
toString() - Method in enum org.springframework.hateoas.TemplateVariable.VariableType
 
toString() - Method in class org.springframework.hateoas.TemplateVariables
 
toString() - Method in class org.springframework.hateoas.UriTemplate
 
toString() - Method in class org.springframework.hateoas.VndErrors
 
toString() - Method in class org.springframework.hateoas.VndErrors.VndError
 
toUri() - Method in class org.springframework.hateoas.core.LinkBuilderSupport
 
toUri() - Method in interface org.springframework.hateoas.LinkBuilder
Creates a URI of the link built by the current builder instance.
toUriComponentsBuilder() - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Returns a UriComponentsBuilder to continue to build the already built URI in a more fine grained way.
Traverson - Class in org.springframework.hateoas.client
Component to ease traversing hypermedia APIs by following links with relation types.
Traverson(URI, MediaType...) - Constructor for class org.springframework.hateoas.client.Traverson
Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.
Traverson(URI, List<MediaType>) - Constructor for class org.springframework.hateoas.client.Traverson
Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.
Traverson.TraversalBuilder - Class in org.springframework.hateoas.client
Builder API to customize traversals.
TrueOnlyBooleanSerializer() - Constructor for class org.springframework.hateoas.hal.Jackson2HalModule.TrueOnlyBooleanSerializer
 
Type - Enum in org.springframework.hateoas.alps
An enum for ALPS descriptor types
TypeConstrainedMappingJackson2HttpMessageConverter - Class in org.springframework.hateoas.mvc
Extension of MappingJackson2HttpMessageConverter to constrain the ability to read and write HTTP message based on the target type.
TypeConstrainedMappingJackson2HttpMessageConverter(Class<?>) - Constructor for class org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter
Creates a new TypeConstrainedMappingJackson2HttpMessageConverter for the given type.
typeIdResolverInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
 
TypeReferences - Class in org.springframework.hateoas.mvc
Helper to easily create ParameterizedTypeReference instances to Spring HATEOAS resource types.
TypeReferences() - Constructor for class org.springframework.hateoas.mvc.TypeReferences
 
TypeReferences.PagedResourcesType<T> - Class in org.springframework.hateoas.mvc
A ParameterizedTypeReference to return a PagedResources of some type.
TypeReferences.ResourcesType<T> - Class in org.springframework.hateoas.mvc
A ParameterizedTypeReference to return a Resources of some type.
TypeReferences.ResourceType<T> - Class in org.springframework.hateoas.mvc
A ParameterizedTypeReference to return a Resource of some type.
typeResolverBuilderInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.hateoas.hal.Jackson2HalModule.HalHandlerInstantiator
 

U

UriComponentsContributor - Interface in org.springframework.hateoas.mvc
SPI callback to enhance a UriComponentsBuilder when referring to a method through a dummy method invocation.
UriTemplate - Class in org.springframework.hateoas
Custom URI template to support qualified URI template variables.
UriTemplate(String) - Constructor for class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate using the given template string.
UriTemplate(String, TemplateVariables) - Constructor for class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate from the given base URI and TemplateVariables.

V

valueOf(String) - Static method in enum org.springframework.hateoas.alps.Format
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.hateoas.alps.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.hateoas.hal.HalConfiguration.RenderSingleLinks
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.springframework.hateoas.Link
Factory method to easily create Link instances from RFC-5988 compatible String representations of a link.
valueOf(String) - Static method in class org.springframework.hateoas.Links
Creates a Links instance from the given RFC5988-compatible link format.
valueOf(String) - Static method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.hateoas.alps.Format
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.alps.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.hal.HalConfiguration.RenderSingleLinks
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.hateoas.TemplateVariable.VariableType
Returns an array containing the constants of this enum type, in the order they are declared.
VndError(String, String, Link...) - Constructor for class org.springframework.hateoas.VndErrors.VndError
Creates a new VndErrors.VndError with the given logref, a message as well as some Links.
VndError() - Constructor for class org.springframework.hateoas.VndErrors.VndError
Protected default constructor to allow JAXB marshalling.
VndErrors - Class in org.springframework.hateoas
A representation model class to be rendered as specified for the media type application/vnd.error.
VndErrors(String, String, Link...) - Constructor for class org.springframework.hateoas.VndErrors
Creates a new VndErrors instance containing a single VndErrors.VndError with the given logref, message and optional Links.
VndErrors(VndErrors.VndError, VndErrors.VndError...) - Constructor for class org.springframework.hateoas.VndErrors
Creates a new VndErrors wrapper for at least one VndErrors.VndError.
VndErrors(List<VndErrors.VndError>) - Constructor for class org.springframework.hateoas.VndErrors
Creates a new VndErrors wrapper for the given VndErrors.
VndErrors() - Constructor for class org.springframework.hateoas.VndErrors
Protected default constructor to allow JAXB marshalling.
VndErrors.VndError - Class in org.springframework.hateoas

W

with(TemplateVariables) - Method in class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate with the current TemplateVariables augmented with the given ones.
with(String, TemplateVariable.VariableType) - Method in class org.springframework.hateoas.UriTemplate
Creates a new UriTemplate with a TemplateVariable with the given name and type added.
withHeaders(HttpHeaders) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
The HttpHeaders that shall be used for the requests of the traversal.
withParameter(String, Object) - Method in class org.springframework.hateoas.client.Hop
Add one parameter to the map of parameters.
withRel(String) - Method in class org.springframework.hateoas.core.LinkBuilderSupport
 
withRel(String) - Method in interface org.springframework.hateoas.LinkBuilder
Creates the Link built by the current builder instance with the given rel.
withSelfRel() - Method in class org.springframework.hateoas.core.LinkBuilderSupport
 
withSelfRel() - Method in class org.springframework.hateoas.Link
Returns a Link pointing to the same URI but with the self relation.
withSelfRel() - Method in interface org.springframework.hateoas.LinkBuilder
Creates the Link built by the current builder instance with the default self rel.
withTemplateParameters(Map<String, Object>) - Method in class org.springframework.hateoas.client.Traverson.TraversalBuilder
Adds the given operations parameters to the traversal.
wrap(Object) - Method in class org.springframework.hateoas.core.EmbeddedWrappers
Creates a new EmbeddedWrapper that
wrap(Object, String) - Method in class org.springframework.hateoas.core.EmbeddedWrappers
Creates a new EmbeddedWrapper with the given rel.
wrap(HttpEntity<S>) - Static method in class org.springframework.hateoas.mvc.HeaderLinksResponseEntity
Wraps the given HttpEntity into a HeaderLinksResponseEntity.
wrap(Iterable<S>, PagedResources.PageMetadata) - Static method in class org.springframework.hateoas.PagedResources
Factory method to easily create a PagedResources instance from a set of entities and pagination metadata.
wrap(Iterable<S>) - Static method in class org.springframework.hateoas.Resources
Creates a new Resources instance by wrapping the given domain class instances into a Resource.

_

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

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