org.springframework.integration.util

Class MessagingAnnotationUtils

java.lang.Object

org.springframework.integration.util.MessagingAnnotationUtils

public final class MessagingAnnotationUtils
extends Object

Utility methods to support annotation processing.

Since:

4.0

Author:

Gary Russell, Dave Syer, Gunnar Hillert, Soby Chacko, Artem Bilan

Method Summary

Modifier and Type	Method and Description
static String	endpointIdValue(Method method) Return the EndpointId.value() property, if present.
static Method	findAnnotatedMethod(Object target, Class<? extends Annotation> annotationType)
static Annotation	findMessagePartAnnotation(Annotation[] annotations, boolean payloads) Find the one of Payload, Header or Headers annotation from the provided annotations array.
static boolean	hasValue(Object value)
static <T> T	resolveAttribute(List<Annotation> annotations, String name, Class<T> requiredType) Get the attribute value from the annotation hierarchy, returning the first non-empty value closest to the annotated method.

Methods inherited from class java.lang.Object

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

Method Detail

resolveAttribute

public static <T> T resolveAttribute(List<Annotation> annotations,
                                     String name,
                                     Class<T> requiredType)

Get the attribute value from the annotation hierarchy, returning the first non-empty value closest to the annotated method. While traversing up the hierarchy, for string-valued attributes, an empty string is ignored. For array-valued attributes, an empty array is ignored. The overridden attribute must be the same type.

Type Parameters:

T - The type.

Parameters:

annotations - The meta-annotations in order (closest first).

name - The attribute name.

requiredType - The expected type.

Returns:

The value.

hasValue

public static boolean hasValue(Object value)

findAnnotatedMethod

public static Method findAnnotatedMethod(Object target,
                                         Class<? extends Annotation> annotationType)

findMessagePartAnnotation

public static Annotation findMessagePartAnnotation(Annotation[] annotations,
                                                   boolean payloads)

Find the one of Payload, Header or Headers annotation from the provided annotations array. Optionally also detects Payloads.

Parameters:

annotations - the annotations to scan.

payloads - true if @Payloads should be detected.

Returns:

the matched annotation or null.

Throws:

MessagingException - if more than one of Payload, Header or Headers annotations are presented.

endpointIdValue

public static String endpointIdValue(Method method)

Return the EndpointId.value() property, if present.

Parameters:

method - the methods.

Returns:

the id, or null.

Since:

5.0.4