feign

Class DeclarativeContract

java.lang.Object

feign.Contract.BaseContract

feign.DeclarativeContract

All Implemented Interfaces:

Contract

Direct Known Subclasses:

Contract.Default

public abstract class DeclarativeContract
extends Contract.BaseContract

Contract base implementation that works by declaring witch annotations should be processed and how each annotation modifies MethodMetadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeclarativeContract.AnnotationProcessor<E extends Annotation>
static interface	DeclarativeContract.ParameterAnnotationProcessor<E extends Annotation>

Nested classes/interfaces inherited from interface feign.Contract

Contract.BaseContract, Contract.Default

Constructor Summary

Constructors

Constructor and Description
DeclarativeContract()

Method Summary

Modifier and Type	Method and Description
List<MethodMetadata>	parseAndValidateMetadata(Class<?> targetType) Called to parse the methods in the class that are linked to HTTP requests.
protected void	processAnnotationOnClass(MethodMetadata data, Class<?> targetType) Called by parseAndValidateMetadata twice, first on the declaring class, then on the target type (unless they are the same).
protected void	processAnnotationOnMethod(MethodMetadata data, Annotation annotation, Method method)
protected boolean	processAnnotationsOnParameter(MethodMetadata data, Annotation[] annotations, int paramIndex)
protected <E extends Annotation> void	registerClassAnnotation(Class<E> annotationType, DeclarativeContract.AnnotationProcessor<E> processor) Called while class annotations are being processed
protected <E extends Annotation> void	registerClassAnnotation(Predicate<E> predicate, DeclarativeContract.AnnotationProcessor<E> processor) Called while class annotations are being processed
protected <E extends Annotation> void	registerMethodAnnotation(Class<E> annotationType, DeclarativeContract.AnnotationProcessor<E> processor) Called while method annotations are being processed
protected <E extends Annotation> void	registerMethodAnnotation(Predicate<E> predicate, DeclarativeContract.AnnotationProcessor<E> processor) Called while method annotations are being processed
protected <E extends Annotation> void	registerParameterAnnotation(Class<E> annotation, DeclarativeContract.ParameterAnnotationProcessor<E> processor) Called while method parameter annotations are being processed

Methods inherited from class feign.Contract.BaseContract

nameParam, parseAndValidateMetadata, parseAndValidateMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

DeclarativeContract

public DeclarativeContract()

Method Detail

parseAndValidateMetadata

public final List<MethodMetadata> parseAndValidateMetadata(Class<?> targetType)

Description copied from interface: Contract

Called to parse the methods in the class that are linked to HTTP requests.

Specified by:

parseAndValidateMetadata in interface Contract

Overrides:

parseAndValidateMetadata in class Contract.BaseContract

Parameters:

targetType - type of the Feign interface.

See Also:

Contract.BaseContract.parseAndValidateMetadata(Class)

processAnnotationOnClass

protected final void processAnnotationOnClass(MethodMetadata data,
                                              Class<?> targetType)

Called by parseAndValidateMetadata twice, first on the declaring class, then on the target type (unless they are the same).

Specified by:

processAnnotationOnClass in class Contract.BaseContract

Parameters:

data - metadata collected so far relating to the current java method.

clz - the class to process

processAnnotationOnMethod

protected final void processAnnotationOnMethod(MethodMetadata data,
                                               Annotation annotation,
                                               Method method)

Specified by:

processAnnotationOnMethod in class Contract.BaseContract

Parameters:

data - metadata collected so far relating to the current java method.

annotation - annotations present on the current method annotation.

method - method currently being processed.

processAnnotationsOnParameter

protected final boolean processAnnotationsOnParameter(MethodMetadata data,
                                                      Annotation[] annotations,
                                                      int paramIndex)

Specified by:

processAnnotationsOnParameter in class Contract.BaseContract

Parameters:

data - metadata collected so far relating to the current java method.

annotations - annotations present on the current parameter annotation.

paramIndex - if you find a name in annotations, call Contract.BaseContract.nameParam(MethodMetadata, String, int) with this as the last parameter.

Returns:

true if you called Contract.BaseContract.nameParam(MethodMetadata, String, int) after finding an http-relevant annotation.

registerClassAnnotation

protected <E extends Annotation> void registerClassAnnotation(Class<E> annotationType,
                                                              DeclarativeContract.AnnotationProcessor<E> processor)

Called while class annotations are being processed

Parameters:

annotationType - to be processed

processor - function that defines the annotations modifies MethodMetadata

registerClassAnnotation

protected <E extends Annotation> void registerClassAnnotation(Predicate<E> predicate,
                                                              DeclarativeContract.AnnotationProcessor<E> processor)

Called while class annotations are being processed

Parameters:

predicate - to check if the annotation should be processed or not

processor - function that defines the annotations modifies MethodMetadata

registerMethodAnnotation

protected <E extends Annotation> void registerMethodAnnotation(Class<E> annotationType,
                                                               DeclarativeContract.AnnotationProcessor<E> processor)

Called while method annotations are being processed

Parameters:

annotationType - to be processed

processor - function that defines the annotations modifies MethodMetadata

registerMethodAnnotation

protected <E extends Annotation> void registerMethodAnnotation(Predicate<E> predicate,
                                                               DeclarativeContract.AnnotationProcessor<E> processor)

Called while method annotations are being processed

Parameters:

predicate - to check if the annotation should be processed or not

processor - function that defines the annotations modifies MethodMetadata

registerParameterAnnotation

protected <E extends Annotation> void registerParameterAnnotation(Class<E> annotation,
                                                                  DeclarativeContract.ParameterAnnotationProcessor<E> processor)

Called while method parameter annotations are being processed

Parameters:

annotation - to be processed

processor - function that defines the annotations modifies MethodMetadata