Spring Hateoas
A C E G H I L O R S T 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.
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.ResourceSupport
 

G

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.
getRel() - Method in class org.springframework.hateoas.Link
Returns the rel of the link.

H

hashCode() - Method in class org.springframework.hateoas.Link
 
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.

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

O

org.springframework.hateoas - package org.springframework.hateoas
Value objects to ease creating Links and link driven representations for REST webservices.
org.springframework.hateoas.mvc - package org.springframework.hateoas.mvc
Spring MVC helper classes to build Links and assemble ResourceSupport types.

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
 
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.
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 class org.springframework.hateoas.mvc.ControllerLinkBuilder
Adds the given object's String representation as sub-resource to the current URI.
slash(Identifiable<?>) - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Adds the given AbstractEntity's id as sub-resource.

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.ControllerLinkBuilder
 
toString() - Method in class org.springframework.hateoas.ResourceSupport
 
toUri() - Method in class org.springframework.hateoas.mvc.ControllerLinkBuilder
Returns a URI resulting from the uriComponents.

W

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

A C E G H I L O R S T W
Spring Hateoas

Copyright © 2012 SpringSource, a division of VMware. All Rights Reserved.