com.asakusafw.operator.util

Class AnnotationHelper

java.lang.Object

com.asakusafw.operator.util.AnnotationHelper

public final class AnnotationHelper
extends Object

Common helper methods about annotations.

Method Summary

Modifier and Type	Method and Description
static <T> List<T>	extractList(CompileEnvironment environment, Class<T> componentValueType, List<? extends AnnotationValue> values) Extracts component values in the target list.
static AnnotationMirror	findAnnotation(CompileEnvironment environment, TypeElement annotationDecl, Element element) Returns the annotation presented in the target element.
static AnnotationValue	getValue(CompileEnvironment environment, AnnotationMirror annotation, String name) Returns the value of annotation member.
static Map<String,AnnotationValue>	getValues(CompileEnvironment environment, AnnotationMirror annotation) Returns the name-value pairs in annotation.
static List<AnnotationValue>	toValueList(CompileEnvironment environment, AnnotationValue value) Converts the value into component list.

Methods inherited from class java.lang.Object

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

Method Detail

findAnnotation

public static AnnotationMirror findAnnotation(CompileEnvironment environment,
                                              TypeElement annotationDecl,
                                              Element element)

Returns the annotation presented in the target element.

Parameters:

environment - current environment

annotationDecl - target annotation type element

element - target annotated element

Returns:

target annotation (includes inherited annotations), or null if does not present

Throws:

IllegalArgumentException - if some parameters were null

getValues

public static Map<String,AnnotationValue> getValues(CompileEnvironment environment,
                                                    AnnotationMirror annotation)

Returns the name-value pairs in annotation.

Parameters:

environment - current environment

annotation - target annotation

Returns:

element name and its value pairs

Throws:

IllegalArgumentException - if some parameters were null

getValue

public static AnnotationValue getValue(CompileEnvironment environment,
                                       AnnotationMirror annotation,
                                       String name)

Returns the value of annotation member.

Parameters:

environment - current environment

annotation - target annotation

name - target annotation member name

Returns:

the related value (may be default value), or null if the member is not declared

Throws:

IllegalArgumentException - if some parameters were null

toValueList

public static List<AnnotationValue> toValueList(CompileEnvironment environment,
                                                AnnotationValue value)

Converts the value into component list. If target value does not represents a list, this returns just consists of the target value.

Parameters:

environment - current environment

value - target annotation value

Returns:

the component list

Throws:

IllegalArgumentException - if some parameters were null

extractList

public static <T> List<T> extractList(CompileEnvironment environment,
                                      Class<T> componentValueType,
                                      List<? extends AnnotationValue> values)

Extracts component values in the target list.

Type Parameters:

T - component value type

Parameters:

environment - current environment

componentValueType - target value type, the returning list only includes values with this type

values - target annotation values

Returns:

component values in the list

Throws:

IllegalArgumentException - if some parameters were null