org.springframework.hateoas.server.core

Class AnnotationLinkRelationProvider

java.lang.Object

org.springframework.hateoas.server.core.AnnotationLinkRelationProvider

All Implemented Interfaces:

Ordered, LinkRelationProvider, org.springframework.plugin.core.Plugin<LinkRelationProvider.LookupContext>

public class AnnotationLinkRelationProvider
extends Object
implements LinkRelationProvider, Ordered

LinkRelationProvider that evaluates the Relation annotation on entity types.

Author:

Oliver Gierke, Alexander Baetz, Greg Turnquist

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.hateoas.server.LinkRelationProvider

LinkRelationProvider.LookupContext

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AnnotationLinkRelationProvider()

Method Summary

Modifier and Type	Method and Description
LinkRelation	getCollectionResourceRelFor(Class<?> type) Returns the relation type to be used to point to a collection resource of the given type.
LinkRelation	getItemResourceRelFor(Class<?> type) Returns the relation type to be used to point to an item resource of the given type.
int	getOrder()
boolean	supports(LinkRelationProvider.LookupContext context) Callback method to manually select LinkRelationProvider implementations based on a given LinkRelationProvider.LookupContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationLinkRelationProvider

public AnnotationLinkRelationProvider()

Method Detail

getCollectionResourceRelFor

public LinkRelation getCollectionResourceRelFor(Class<?> type)

Description copied from interface: LinkRelationProvider

Returns the relation type to be used to point to a collection resource of the given type.

Specified by:

getCollectionResourceRelFor in interface LinkRelationProvider

Parameters:

type - must not be null.

Returns:

getItemResourceRelFor

public LinkRelation getItemResourceRelFor(Class<?> type)

Description copied from interface: LinkRelationProvider

Returns the relation type to be used to point to an item resource of the given type.

Specified by:

getItemResourceRelFor in interface LinkRelationProvider

Parameters:

type - must not be null.

Returns:

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

supports

public boolean supports(LinkRelationProvider.LookupContext context)

Description copied from interface: LinkRelationProvider

Callback method to manually select LinkRelationProvider implementations based on a given LinkRelationProvider.LookupContext. User code shouldn't need to call this method explicitly but rather use DelegatingLinkRelationProvider, equip that with a set of LinkRelationProvider implementations as that will perform the selection of the matching one on invocations of LinkRelationProvider.getItemResourceRelFor(Class) and LinkRelationProvider.getCollectionResourceRelFor(Class) transparently.

Specified by:

supports in interface LinkRelationProvider

Specified by:

supports in interface org.springframework.plugin.core.Plugin<LinkRelationProvider.LookupContext>

See Also:

Plugin.supports(java.lang.Object)