org.restlet.engine.resource
Class AnnotationInfo

java.lang.Object
  extended by org.restlet.engine.resource.AnnotationInfo

public class AnnotationInfo
extends Object

Descriptor for method annotations.

Author:
Jerome Louvel

Constructor Summary
AnnotationInfo(Class<?> resourceClass, Method restletMethod, Method javaMethod, String value)
          Constructor.
 
Method Summary
 boolean equals(Object other)
          Indicates if the current variant is equal to the given variant.
 String getInput()
          Returns the input part of the annotation value.
 Class<?>[] getJavaInputTypes()
          Returns the input types of the Java method.
 Method getJavaMethod()
          Returns the annotated Java method.
 Class<?> getJavaOutputType()
          Returns the output type of the Java method.
 String getOutput()
          Returns the output part of the annotation value.
 String getQuery()
          Returns the optional query part of the annotation value.
 List<Variant> getRequestVariants(MetadataService metadataService, ConverterService converterService)
          Returns a list of request variants based on the annotation value.
 Class<?> getResourceClass()
          Returns the resource interface value.
 List<Variant> getResponseVariants(MetadataService metadataService, ConverterService converterService)
          Returns a list of response variants based on the annotation value.
 Method getRestletMethod()
          Returns the matching Restlet method.
 boolean isCompatible(Method restletMethod, Form queryParams, Representation requestEntity, MetadataService metadataService, ConverterService converterService)
          Indicates if the annotated method described is compatible with the given parameters.
 boolean isCompatibleRequestEntity(Representation requestEntity, MetadataService metadataService, ConverterService converterService)
          Indicates if the given request entity is compatible with the annotated method described.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AnnotationInfo

public AnnotationInfo(Class<?> resourceClass,
                      Method restletMethod,
                      Method javaMethod,
                      String value)
Constructor.

Parameters:
resourceClass - The class or interface that hosts the annotated Java method.
restletMethod - The matching Restlet method.
javaMethod - The annotated Java method.
value - The annotation value.
Method Detail

equals

public boolean equals(Object other)
Indicates if the current variant is equal to the given variant.

Overrides:
equals in class Object
Parameters:
other - The other variant.
Returns:
True if the current variant includes the other.

getInput

public String getInput()
Returns the input part of the annotation value.

Returns:
The input part of the annotation value.

getJavaInputTypes

public Class<?>[] getJavaInputTypes()
Returns the input types of the Java method.

Returns:
The input types of the Java method.

getJavaMethod

public Method getJavaMethod()
Returns the annotated Java method.

Returns:
The annotated Java method.

getJavaOutputType

public Class<?> getJavaOutputType()
Returns the output type of the Java method.

Returns:
The output type of the Java method.

getOutput

public String getOutput()
Returns the output part of the annotation value.

Returns:
The output part of the annotation value.

getQuery

public String getQuery()
Returns the optional query part of the annotation value.

Returns:
The optional query part of the annotation value.

getRequestVariants

public List<Variant> getRequestVariants(MetadataService metadataService,
                                        ConverterService converterService)
Returns a list of request variants based on the annotation value.

Parameters:
metadataService - The metadata service to use.
Returns:
A list of request variants.

getResourceClass

public Class<?> getResourceClass()
Returns the resource interface value.

Returns:
The resource interface value.

getResponseVariants

public List<Variant> getResponseVariants(MetadataService metadataService,
                                         ConverterService converterService)
Returns a list of response variants based on the annotation value.

Parameters:
metadataService - The metadata service to use.
converterService - The converter service to use.
Returns:
A list of response variants.

getRestletMethod

public Method getRestletMethod()
Returns the matching Restlet method.

Returns:
The matching Restlet method.

isCompatible

public boolean isCompatible(Method restletMethod,
                            Form queryParams,
                            Representation requestEntity,
                            MetadataService metadataService,
                            ConverterService converterService)
Indicates if the annotated method described is compatible with the given parameters.

Parameters:
restletMethod - The Restlet method to match.
requestEntity - Optional request entity.
metadataService - The metadata service to use.
converterService - The converter service to use.
Returns:
True if the annotated method is compatible.

isCompatibleRequestEntity

public boolean isCompatibleRequestEntity(Representation requestEntity,
                                         MetadataService metadataService,
                                         ConverterService converterService)
Indicates if the given request entity is compatible with the annotated method described.

Parameters:
requestEntity - Optional request entity.
metadataService - The metadata service to use.
converterService - The converter service to use.
Returns:
True if the given request entity is compatible with the annotated method described.

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2005-2013 Restlet.