Class AnnotationLinkRelationProvider
java.lang.Object
org.springframework.hateoas.server.core.AnnotationLinkRelationProvider
- All Implemented Interfaces:
Ordered
,LinkRelationProvider
,org.springframework.plugin.core.Plugin<LinkRelationProvider.LookupContext>
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 -
Method Summary
Modifier and TypeMethodDescriptiongetCollectionResourceRelFor
(Class<?> type) Returns the relation type to be used to point to a collection resource of the given type.getItemResourceRelFor
(Class<?> type) Returns the relation type to be used to point to an item resource of the given type.int
getOrder()
boolean
Callback method to manually selectLinkRelationProvider
implementations based on a givenLinkRelationProvider.LookupContext
.
-
Constructor Details
-
AnnotationLinkRelationProvider
public AnnotationLinkRelationProvider()
-
-
Method Details
-
getCollectionResourceRelFor
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 interfaceLinkRelationProvider
- Parameters:
type
- must not be null.- Returns:
-
getItemResourceRelFor
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 interfaceLinkRelationProvider
- Parameters:
type
- must not be null.- Returns:
-
getOrder
public int getOrder() -
supports
Description copied from interface:LinkRelationProvider
Callback method to manually selectLinkRelationProvider
implementations based on a givenLinkRelationProvider.LookupContext
. User code shouldn't need to call this method explicitly but rather useDelegatingLinkRelationProvider
, equip that with a set ofLinkRelationProvider
implementations as that will perform the selection of the matching one on invocations ofLinkRelationProvider.getItemResourceRelFor(Class)
andLinkRelationProvider.getCollectionResourceRelFor(Class)
transparently.- Specified by:
supports
in interfaceLinkRelationProvider
- Specified by:
supports
in interfaceorg.springframework.plugin.core.Plugin<LinkRelationProvider.LookupContext>
- See Also:
-
Plugin.supports(java.lang.Object)
-