org.eclipse.jpt.common.core.utility.jdt
Interface AnnotationAdapter

All Known Subinterfaces:

IndexedAnnotationAdapter

public interface AnnotationAdapter

Adapt a Java annotation 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

Annotation	getAnnotation(CompilationUnit astRoot) Given the specified compilation unit, return the value of the adapter's annotation.
ASTNode	getAstNode(CompilationUnit astRoot) Return the AST node corresponding to the annotation.
MarkerAnnotation	newMarkerAnnotation() Build and return a new marker annotation, replacing the original annotation if present.
NormalAnnotation	newNormalAnnotation() Build and return a new normal annotation, replacing the original annotation if present.
SingleMemberAnnotation	newSingleMemberAnnotation() Build and return a new single member annotation, replacing the original annotation if present.
void	removeAnnotation() Remove the annotation.

Method Detail

getAnnotation

Annotation getAnnotation(CompilationUnit astRoot)

Given the specified compilation unit, return the value of the adapter's annotation.

newMarkerAnnotation

MarkerAnnotation newMarkerAnnotation()

Build and return a new marker annotation, replacing the original annotation if present.

newSingleMemberAnnotation

SingleMemberAnnotation newSingleMemberAnnotation()

Build and return a new single member annotation, replacing the original annotation if present.

newNormalAnnotation

NormalAnnotation newNormalAnnotation()

Build and return a new normal annotation, replacing the original annotation if present.

removeAnnotation

void removeAnnotation()

Remove the annotation.

getAstNode

ASTNode getAstNode(CompilationUnit astRoot)

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