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

Type Parameters:

T - the type of the object to be passed to and returned by the adapter

All Known Subinterfaces:

IndexedDeclarationAnnotationElementAdapter<T>

public interface DeclarationAnnotationElementAdapter<T>

Provide clients with a pluggable way to manipulate an annotation element modifying a "declaration".

This interface is not intended to be implemented by clients.

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.

Field Summary

static String

VALUE Reduce the number of NLS warnings.

Method Summary

ASTNode	getAstNode(ModifiedDeclaration declaration) Given the specified declaration, return the AST node corresponding to the element's value.
Expression	getExpression(Annotation astAnnotation) Given the specified annotation, return the element's value expression.
Expression	getExpression(ModifiedDeclaration declaration) Given the specified declaration, return the element's value expression.
T	getValue(Annotation astAnnotation) Given the specified annotation, return the value of the annotation element.
T	getValue(ModifiedDeclaration declaration) Given the specified declaration, return the value of the annotation element.
void	setValue(T value, ModifiedDeclaration declaration) Given the specified declaration, set the value of the annotation element.

Field Detail

VALUE

static final String VALUE

Reduce the number of NLS warnings.

See Also:

Constant Field Values

Method Detail

getValue

T getValue(ModifiedDeclaration declaration)

Given the specified declaration, return the value of the annotation element. Return null or an empty array if the element is not present. If the annotation is available, getValue(Annotation) might be more performant.

See Also:

getValue(Annotation)

getValue

T getValue(Annotation astAnnotation)

Given the specified annotation, return the value of the annotation element. Return null or an empty array if the element is not present.

See Also:

getValue(ModifiedDeclaration)

setValue

void setValue(T value,
              ModifiedDeclaration declaration)

Given the specified declaration, set the value of the annotation element. Setting the value of the element to null will cause the element to be removed from its annotation.

getExpression

Expression getExpression(ModifiedDeclaration declaration)

Given the specified declaration, return the element's value expression. 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 annotation, return the element's value expression. Return null if the element is not present.

See Also:

getExpression(ModifiedDeclaration)

getAstNode

ASTNode getAstNode(ModifiedDeclaration declaration)

Given the specified declaration, return the AST node corresponding to the element's value. If the element is missing, return the annotation's node.