org.springframework.hateoas.server.core

Class DelegatingLinkRelationProvider

java.lang.Object

org.springframework.hateoas.server.core.DelegatingLinkRelationProvider

All Implemented Interfaces:

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

public class DelegatingLinkRelationProvider
extends Object
implements LinkRelationProvider

Author:

Oliver Gierke

Nested Class Summary

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

LinkRelationProvider.LookupContext

Constructor Summary

Constructors

Constructor and Description
DelegatingLinkRelationProvider(LinkRelationProvider... providers) Creates a new DefaultLinkRelationProvider for the given LinkRelationProviders.
DelegatingLinkRelationProvider(org.springframework.plugin.core.PluginRegistry<LinkRelationProvider,LinkRelationProvider.LookupContext> providers)

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.
boolean	supports(LinkRelationProvider.LookupContext delimiter) 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

DelegatingLinkRelationProvider

public DelegatingLinkRelationProvider(LinkRelationProvider... providers)

Creates a new DefaultLinkRelationProvider for the given LinkRelationProviders.

Parameters:

providers - must not be null.

DelegatingLinkRelationProvider

public DelegatingLinkRelationProvider(org.springframework.plugin.core.PluginRegistry<LinkRelationProvider,LinkRelationProvider.LookupContext> providers)

Method Detail

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:

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:

supports

public boolean supports(LinkRelationProvider.LookupContext delimiter)

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)