Spring Hateoas

org.springframework.hateoas.core
Class AnnotationRelProvider

java.lang.Object
  extended by org.springframework.hateoas.core.AnnotationRelProvider
All Implemented Interfaces:
RelProvider, org.springframework.plugin.core.Plugin<Class<?>>

public class AnnotationRelProvider
extends Object
implements RelProvider

Author:
Oliver Gierke, Alexander Baetz

Constructor Summary
AnnotationRelProvider()
           
 
Method Summary
 String getCollectionResourceRelFor(Class<?> type)
          Returns the relation type to be used to point to a collection resource of the given type.
 String getItemResourceRelFor(Class<?> type)
          Returns the relation type to be used to point to an item resource of the given type.
 boolean supports(Class<?> delimiter)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnnotationRelProvider

public AnnotationRelProvider()
Method Detail

getCollectionResourceRelFor

public String getCollectionResourceRelFor(Class<?> type)
Description copied from interface: RelProvider
Returns the relation type to be used to point to a collection resource of the given type.

Specified by:
getCollectionResourceRelFor in interface RelProvider
Parameters:
type - must not be null.
Returns:

getItemResourceRelFor

public String getItemResourceRelFor(Class<?> type)
Description copied from interface: RelProvider
Returns the relation type to be used to point to an item resource of the given type.

Specified by:
getItemResourceRelFor in interface RelProvider
Parameters:
type - must not be null.
Returns:

supports

public boolean supports(Class<?> delimiter)
Specified by:
supports in interface org.springframework.plugin.core.Plugin<Class<?>>

Spring Hateoas

Copyright © 2012-2014-2014 Pivotal, Inc.. All Rights Reserved.