org.eclipse.jpt.common.core.utility.jdt
Interface AnnotationElementAdapter<T>

public interface AnnotationElementAdapter<T>

Adapt a Java annotation element with a simple-to-use interface. Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves. This interface is not intended to be implemented by clients.

Method Summary

ASTNode	getAstNode(CompilationUnit astRoot) Return the AST node corresponding to the element.
Expression	getExpression(Annotation astAnnotation) Given the specified compilation unit, return the expression value of the adapter's annotation element.
Expression	getExpression(CompilationUnit astRoot) Given the specified compilation unit, return the expression value of the adapter's annotation element.
T	getValue() Return the value of the adapter's annotation element.
T	getValue(Annotation astAnnotation) Given the specified annotation, return the value of the adapter's annotation element.
T	getValue(CompilationUnit astRoot) Given the specified compilation unit, return the value of the adapter's annotation element.
void	setValue(T value) Set the value of the adapter's annotation element.

Method Detail

getValue

T getValue()

Return the value of the adapter's annotation element. Return null if the element is not present. If the compilation unit is available, getValue(CompilationUnit) might be more performant. If the annotation is available, getValue(Annotation) might be more performant.

See Also:

getValue(CompilationUnit), getValue(Annotation)

getValue

T getValue(CompilationUnit astRoot)

Given the specified compilation unit, return the value of the adapter's annotation element. Return null if the element is not present. If the annotation is available, getValue(Annotation) might be more performant.

See Also:

getValue(), getValue(Annotation)

getValue

T getValue(Annotation astAnnotation)

Given the specified annotation, return the value of the adapter's annotation element. Return null if the element is not present.

See Also:

getValue()

setValue

void setValue(T value)

Set the value of the adapter's annotation element. Setting the value of the element to null will cause the element to be removed from its annotation.

getExpression

Expression getExpression(CompilationUnit astRoot)

Given the specified compilation unit, return the expression value of the adapter's annotation element. Return null if the element is not present. If the annotation is available, getExpression(Annotation) might be more performant

See Also:

getExpression(Annotation)

getExpression

Expression getExpression(Annotation astAnnotation)

Given the specified compilation unit, return the expression value of the adapter's annotation element. Return null if the element is not present.

See Also:

getExpression(CompilationUnit)

getAstNode

ASTNode getAstNode(CompilationUnit astRoot)

Return the AST node corresponding to the element. If the element is missing, return the annotation's node.