org.restlet.engine.resource

Class MethodAnnotationInfo

java.lang.Object

org.restlet.engine.resource.AnnotationInfo

org.restlet.engine.resource.MethodAnnotationInfo

public class MethodAnnotationInfo
extends AnnotationInfo

Descriptor for method annotations.

Author:

Jerome Louvel

Field Summary

Fields inherited from class org.restlet.engine.resource.AnnotationInfo

annotationValue, javaClass, javaMethod, javaMethodImpl

Constructor Summary

Constructors

Constructor and Description
MethodAnnotationInfo(java.lang.Class<?> javaClass, Method restletMethod, java.lang.reflect.Method javaMethod, java.lang.String annotationValue) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Indicates if the current object is equal to the given object.
java.lang.String	getInput() Returns the input part of the annotation value.
java.lang.Class<?>[]	getJavaInputTypes() Returns the input types of the Java method.
java.lang.Class<?>	getJavaOutputType() Returns the output type of the Java method.
java.lang.String	getOutput() Returns the output part of the annotation value.
java.lang.String	getQuery() Returns the optional query part of the annotation value.
java.util.List<Variant>	getRequestVariants(MetadataService metadataService, ConverterService converterService) Returns a list of request variants based on the annotation value.
java.util.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.
java.lang.String	toString()

Methods inherited from class org.restlet.engine.resource.AnnotationInfo

getAnnotationValue, getJavaActualType, getJavaActualType, getJavaActualType, getJavaClass, getJavaMethod, getTypeClass

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodAnnotationInfo

public MethodAnnotationInfo(java.lang.Class<?> javaClass,
                    Method restletMethod,
                    java.lang.reflect.Method javaMethod,
                    java.lang.String annotationValue)

Constructor.

Parameters:

javaClass - The class or interface that hosts the annotated Java method.

restletMethod - The matching Restlet method.

javaMethod - The annotated Java method.

annotationValue - The annotation value.

Method Detail

equals

public boolean equals(java.lang.Object other)

Indicates if the current object is equal to the given object.

Overrides:

equals in class AnnotationInfo

Parameters:

other - The other object.

Returns:

True if the current object includes the other.

getInput

public java.lang.String getInput()

Returns the input part of the annotation value.

Returns:

The input part of the annotation value.

getJavaInputTypes

public java.lang.Class<?>[] getJavaInputTypes()

Returns the input types of the Java method.

Returns:

The input types of the Java method.

getJavaOutputType

public java.lang.Class<?> getJavaOutputType()

Returns the output type of the Java method.

Returns:

The output type of the Java method.

getOutput

public java.lang.String getOutput()

Returns the output part of the annotation value.

Returns:

The output part of the annotation value.

getQuery

public java.lang.String getQuery()

Returns the optional query part of the annotation value.

Returns:

The optional query part of the annotation value.

getRequestVariants

public java.util.List<Variant> getRequestVariants(MetadataService metadataService,
                                         ConverterService converterService)
                                           throws java.io.IOException

Returns a list of request variants based on the annotation value.

Parameters:

metadataService - The metadata service to use.

Returns:

A list of request variants.

Throws:

java.io.IOException

getResponseVariants

public java.util.List<Variant> getResponseVariants(MetadataService metadataService,
                                          ConverterService converterService)
                                            throws java.io.IOException

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.

Throws:

java.io.IOException

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)
                     throws java.io.IOException

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.

Throws:

java.io.IOException

isCompatibleRequestEntity

public boolean isCompatibleRequestEntity(Representation requestEntity,
                                MetadataService metadataService,
                                ConverterService converterService)
                                  throws java.io.IOException

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.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class AnnotationInfo