org.jsweet.transpiler.extension

Class AnnotationManager

java.lang.Object

org.jsweet.transpiler.extension.AnnotationManager

public abstract class AnnotationManager
extends Object

This class has to be overridden to adapt the way annotations are introspected on the Java AST. Annotation managers should be installed on the JSweet context in order to add or remove annotations ( manageAnnotation(Element, String)) and/or customize the values of their properties.

Author:

Renaud Pawlak

See Also:

JSweetContext#addAnnotationManager(AnnotationAdapter)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationManager.Action The action to be returned by the manager to add or remove annotations.

Constructor Summary

Constructors

Constructor and Description
AnnotationManager()

Method Summary

Modifier and Type	Method and Description
<T> T	getAnnotationValue(Element element, String annotationType, String propertyName, Class<T> propertyClass, T defaultValue) Gets the given annotation property value.
abstract AnnotationManager.Action	manageAnnotation(Element element, String annotationType) Manages the given annotation type, by returning one of the possible actions (see AnnotationManager.Action).

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationManager

public AnnotationManager()

Method Detail

manageAnnotation

public abstract AnnotationManager.Action manageAnnotation(Element element,
                                                          String annotationType)

Manages the given annotation type, by returning one of the possible actions (see AnnotationManager.Action).

Parameters:

element - the AST element where the annotation shall be managed

annotationType - the managed annotation type (fully qualified name)

Returns:

the action to apply on this annotation, which tells if it is added, removed, or unchanged by this annotation manager

getAnnotationValue

public <T> T getAnnotationValue(Element element,
                                String annotationType,
                                String propertyName,
                                Class<T> propertyClass,
                                T defaultValue)

Gets the given annotation property value.

This method has to be overridden when annotations containing properties are being added by this manager with the manageAnnotation(Element, String) method, or if this manager wants to tune the values of existing annotations (less common scenario).

This method returns null by default, which means that it leaves the job to other managers or to the default behavior.

Parameters:

element - the AST element on which the annotation is defined

annotationType - the annotation type (fully qualified name)

propertyName - the annotation's property name (if null, the value property is looked up)

propertyClass - the annotation's property class

defaultValue - the default value to be returned if not found

Returns:

the annotation property value (null if the annotation is not managed)