A C E G H I J L O P R S T U W

A

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.

ATOM_NAMESPACE - Static variable in class org.springframework.hateoas.Link

C

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 UriComponentsLinkBuilder instances based on the request mapping annotated on the given controller.

ControllerLinkBuilderFactory() - Constructor for class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory

createNewInstance(UriComponentsBuilder) - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilder

createNewInstance(UriComponentsBuilder) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder

createNewInstance(UriComponentsBuilder) - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

Creates a new instance of the sub-class.

createResource(T) - Method in class org.springframework.hateoas.mvc.ResourceAssemblerSupport

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.ResourceAssemblerSupport

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

E

equals(Object) - Method in class org.springframework.hateoas.Link

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

G

getContent() - Method in class org.springframework.hateoas.Resource

Returns the underlying entity.

getContent() - Method in class org.springframework.hateoas.Resources

Returns the underlying elements.

getHref() - Method in class org.springframework.hateoas.Link

Returns the actual URI the link is pointing to.

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.

getLink(String) - Method in class org.springframework.hateoas.ResourceSupport

Returns the link with the given rel.

getLinks() - Method in class org.springframework.hateoas.ResourceSupport

Returns all Links contained in this resource.

getMetadata() - Method in class org.springframework.hateoas.PagedResources

Returns the pagination metadata.

getNumber() - Method in class org.springframework.hateoas.PagedResources.PageMetadata

Returns the number of the current page.

getRel() - Method in class org.springframework.hateoas.Link

Returns the rel of the link.

getSize() - Method in class org.springframework.hateoas.PagedResources.PageMetadata

Returns the requested size of the page.

getThis() - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilder

getThis() - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder

getThis() - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

Returns the current concrete instance.

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.

H

hashCode() - Method in class org.springframework.hateoas.Link

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

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.

I

Identifiable<ID extends Serializable> - Interface in org.springframework.hateoas

Interface to mark objects that are identifiable by an ID of any type.

instantiateResource(T) - Method in class org.springframework.hateoas.mvc.ResourceAssemblerSupport

Instantiates the resource object.

iterator() - Method in class org.springframework.hateoas.Resources

J

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

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() - Constructor for class org.springframework.hateoas.Link

Empty constructor required by the marshalling framework.

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.

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<?>) - Method in class org.springframework.hateoas.jaxrs.JaxRsLinkBuilderFactory

linkTo(Class<?>, Object...) - 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 clas (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<?>) - 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<?>) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory

linkTo(Class<?>, Object...) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilderFactory

O

org.springframework.hateoas - package org.springframework.hateoas

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

org.springframework.hateoas.jaxrs - package org.springframework.hateoas.jaxrs

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.

PagedResources.PageMetadata() - Constructor for class org.springframework.hateoas.PagedResources.PageMetadata

PagedResources.PageMetadata(long, long, long, long) - Constructor for class org.springframework.hateoas.PagedResources.PageMetadata

process(T) - Method in interface org.springframework.hateoas.ResourceProcessor

Processes the given resource, add links, alter the domain data etc.

R

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

Resource<T> - Class in org.springframework.hateoas

A simple Resource wrapping a domain object and adding links to it.

Resource() - Constructor for class org.springframework.hateoas.Resource

Creates an empty Resource.

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 extends Identifiable<?>,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.

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.

ResourceSupport - Class in org.springframework.hateoas

Base class for DTOs to collect links.

ResourceSupport() - Constructor for class org.springframework.hateoas.ResourceSupport

S

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.

slash(Object) - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

slash(Identifiable<?>) - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

T

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 class org.springframework.hateoas.Link

toString() - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

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

toUri() - Method in interface org.springframework.hateoas.LinkBuilder

Creates a URI of the link built by the current builder instance.

toUri() - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

U

UriComponentsLinkBuilder<T extends LinkBuilder> - Class in org.springframework.hateoas.mvc

Base class to implement LinkBuilders based on a Spring MVC UriComponentsBuilder.

UriComponentsLinkBuilder(UriComponentsBuilder) - Constructor for class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

Creates a new UriComponentsLinkBuilder using the given UriComponentsBuilder.

W

withRel(String) - Method in interface org.springframework.hateoas.LinkBuilder

Creates the Link built by the current builder instance with the given rel.

withRel(String) - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

withSelfRel() - Method in interface org.springframework.hateoas.LinkBuilder

Creates the Link built by the current builder instance with the default self rel.

withSelfRel() - Method in class org.springframework.hateoas.mvc.UriComponentsLinkBuilder

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.

A C E G H I J L O P R S T U W