org.apache.dubbo.config.spring.util

Class AnnotationUtils

java.lang.Object

org.apache.dubbo.config.spring.util.AnnotationUtils

public class AnnotationUtils
extends Object

Annotation Utilities Class

Since:

2.5.11

See Also:

AnnotationUtils

Constructor Summary

Constructors

Constructor and Description
AnnotationUtils()

Method Summary

Modifier and Type	Method and Description
static <T> T	getAttribute(org.springframework.core.annotation.AnnotationAttributes attributes, String name) Get the attribute value
static Map<String,Object>	getAttributes(Annotation annotation, boolean ignoreDefaultValue, String... ignoreAttributeNames) Deprecated.
static Map<String,Object>	getAttributes(Annotation annotation, org.springframework.core.env.PropertyResolver propertyResolver, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the Annotation attributes
static org.springframework.core.annotation.AnnotationAttributes	getMergedAttributes(AnnotatedElement annotatedElement, Class<? extends Annotation> annotationType, org.springframework.core.env.PropertyResolver propertyResolver, boolean ignoreDefaultValue, String... ignoreAttributeNames) Get the annotation attributes after merging and resolving the placeholders
static String	resolveInterfaceName(org.springframework.core.annotation.AnnotationAttributes attributes, Class<?> defaultInterfaceClass) Resolve the interface name from AnnotationAttributes
static String	resolveInterfaceName(Reference reference, Class<?> defaultInterfaceClass) Deprecated.
static String	resolveInterfaceName(Service service, Class<?> defaultInterfaceClass) Deprecated.
static Map<String,Object>	resolvePlaceholders(Map<String,Object> sourceAnnotationAttributes, org.springframework.core.env.PropertyResolver propertyResolver, String... ignoreAttributeNames) Resolve the placeholders from the specified annotation attributes
static Class<?>	resolveServiceInterfaceClass(org.springframework.core.annotation.AnnotationAttributes attributes, Class<?> defaultInterfaceClass) Resolve the class of Dubbo Service interface from the specified annotation attributes and annotated class.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationUtils

public AnnotationUtils()

Method Detail

resolveInterfaceName

@Deprecated
public static String resolveInterfaceName(Service service,
                                                      Class<?> defaultInterfaceClass)
                                               throws IllegalStateException

Deprecated.

Throws:

IllegalStateException

resolveInterfaceName

public static String resolveInterfaceName(org.springframework.core.annotation.AnnotationAttributes attributes,
                                          Class<?> defaultInterfaceClass)

Resolve the interface name from AnnotationAttributes

Parameters:

attributes - AnnotationAttributes instance, may be @Service or @Reference

defaultInterfaceClass - the default class of interface

Returns:

the interface name if found

Throws:

IllegalStateException - if interface name was not found

getAttribute

public static <T> T getAttribute(org.springframework.core.annotation.AnnotationAttributes attributes,
                                 String name)

Get the attribute value

Type Parameters:

T - the type of attribute value

Parameters:

attributes - the annotation attributes

name - the name of attribute

Returns:

the attribute value if found

Since:

2.7.3

resolveServiceInterfaceClass

public static Class<?> resolveServiceInterfaceClass(org.springframework.core.annotation.AnnotationAttributes attributes,
                                                    Class<?> defaultInterfaceClass)
                                             throws IllegalArgumentException

Resolve the class of Dubbo Service interface from the specified annotation attributes and annotated class.

Parameters:

attributes - annotation attributes

defaultInterfaceClass - the annotated class.

Returns:

the class of Dubbo Service interface

Throws:

IllegalArgumentException - if can't resolved

resolveInterfaceName

@Deprecated
public static String resolveInterfaceName(Reference reference,
                                                      Class<?> defaultInterfaceClass)
                                               throws IllegalStateException

Deprecated.

Throws:

IllegalStateException

getAttributes

@Deprecated
public static Map<String,Object> getAttributes(Annotation annotation,
                                                           boolean ignoreDefaultValue,
                                                           String... ignoreAttributeNames)

Deprecated.

Get the Annotation attributes

Parameters:

annotation - specified Annotation

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

Returns:

non-null

Since:

2.6.6

getAttributes

public static Map<String,Object> getAttributes(Annotation annotation,
                                               org.springframework.core.env.PropertyResolver propertyResolver,
                                               boolean ignoreDefaultValue,
                                               String... ignoreAttributeNames)

Get the Annotation attributes

Parameters:

annotation - specified Annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

Returns:

non-null

Since:

2.6.6

resolvePlaceholders

public static Map<String,Object> resolvePlaceholders(Map<String,Object> sourceAnnotationAttributes,
                                                     org.springframework.core.env.PropertyResolver propertyResolver,
                                                     String... ignoreAttributeNames)

Resolve the placeholders from the specified annotation attributes

Parameters:

sourceAnnotationAttributes - the source of annotation attributes

propertyResolver - PropertyResolver

ignoreAttributeNames - the attribute names to be ignored

Returns:

a new resolved annotation attributes , non-null and read-only

Since:

2.7.3

getMergedAttributes

public static org.springframework.core.annotation.AnnotationAttributes getMergedAttributes(AnnotatedElement annotatedElement,
                                                                                           Class<? extends Annotation> annotationType,
                                                                                           org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                           boolean ignoreDefaultValue,
                                                                                           String... ignoreAttributeNames)

Get the annotation attributes after merging and resolving the placeholders

Parameters:

annotatedElement - the annotated element

annotationType - the tyoe pf annotation

propertyResolver - PropertyResolver instance, e.g Environment

ignoreDefaultValue - whether ignore default value or not

ignoreAttributeNames - the attribute names of annotation should be ignored

Returns:

If the specified annotation type is not found, return null

Since:

2.7.3