Interface NodeWithAnnotations<N extends Node>
-
- All Known Implementing Classes:
AnnotationDeclaration
,AnnotationMemberDeclaration
,ArrayCreationLevel
,ArrayType
,BodyDeclaration
,CallableDeclaration
,ClassOrInterfaceDeclaration
,ClassOrInterfaceType
,ConstructorDeclaration
,EnumConstantDeclaration
,EnumDeclaration
,FieldDeclaration
,InitializerDeclaration
,IntersectionType
,MethodDeclaration
,ModuleDeclaration
,Name
,PackageDeclaration
,Parameter
,PrimitiveType
,ReceiverParameter
,TypeDeclaration
,TypeParameter
,UnionType
,VariableDeclarationExpr
,VoidType
,WildcardType
public interface NodeWithAnnotations<N extends Node>
A node that can be annotated.- Since:
- July 2014
- Author:
- Federico Tomassetti
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default NormalAnnotationExpr
addAndGetAnnotation(Class<? extends Annotation> clazz)
Annotates this node and automatically add the importdefault NormalAnnotationExpr
addAndGetAnnotation(String name)
Annotates thisdefault N
addAnnotation(AnnotationExpr element)
default N
addAnnotation(Class<? extends Annotation> clazz)
Annotates this node and automatically add the importdefault N
addAnnotation(String name)
Annotates thisdefault N
addMarkerAnnotation(Class<? extends Annotation> clazz)
Annotates this with a marker annotation and automatically add the importdefault N
addMarkerAnnotation(String name)
Annotates this with a marker annotationdefault N
addSingleMemberAnnotation(Class<? extends Annotation> clazz, Expression expression)
Annotates this with a single member annotationdefault N
addSingleMemberAnnotation(Class<? extends Annotation> clazz, String value)
Annotates this with a single member annotation and automatically add the importdefault N
addSingleMemberAnnotation(String name, Expression expression)
Annotates this with a single member annotationdefault N
addSingleMemberAnnotation(String name, String value)
Annotates this with a single member annotationdefault AnnotationExpr
getAnnotation(int i)
default Optional<AnnotationExpr>
getAnnotationByClass(Class<? extends Annotation> annotationClass)
Try to find an annotation by its classdefault Optional<AnnotationExpr>
getAnnotationByName(String annotationName)
Try to find an annotation by its nameNodeList<AnnotationExpr>
getAnnotations()
default boolean
isAnnotationPresent(Class<? extends Annotation> annotationClass)
Check whether an annotation with this class is present on this elementdefault boolean
isAnnotationPresent(String annotationName)
Check whether an annotation with this name is present on this elementdefault N
setAnnotation(int i, AnnotationExpr element)
N
setAnnotations(NodeList<AnnotationExpr> annotations)
void
tryAddImportToParentCompilationUnit(Class<?> clazz)
-
-
-
Method Detail
-
getAnnotations
NodeList<AnnotationExpr> getAnnotations()
-
setAnnotations
N setAnnotations(NodeList<AnnotationExpr> annotations)
-
tryAddImportToParentCompilationUnit
void tryAddImportToParentCompilationUnit(Class<?> clazz)
-
getAnnotation
default AnnotationExpr getAnnotation(int i)
-
setAnnotation
default N setAnnotation(int i, AnnotationExpr element)
-
addAnnotation
default N addAnnotation(AnnotationExpr element)
-
addAnnotation
default N addAnnotation(String name)
Annotates this- Parameters:
name
- the name of the annotation- Returns:
- this
-
addAndGetAnnotation
default NormalAnnotationExpr addAndGetAnnotation(String name)
Annotates this- Parameters:
name
- the name of the annotation- Returns:
- the
NormalAnnotationExpr
added
-
addAnnotation
default N addAnnotation(Class<? extends Annotation> clazz)
Annotates this node and automatically add the import- Parameters:
clazz
- the class of the annotation- Returns:
- this
-
addAndGetAnnotation
default NormalAnnotationExpr addAndGetAnnotation(Class<? extends Annotation> clazz)
Annotates this node and automatically add the import- Parameters:
clazz
- the class of the annotation- Returns:
- the
NormalAnnotationExpr
added
-
addMarkerAnnotation
default N addMarkerAnnotation(String name)
Annotates this with a marker annotation- Parameters:
name
- the name of the annotation- Returns:
- this
-
addMarkerAnnotation
default N addMarkerAnnotation(Class<? extends Annotation> clazz)
Annotates this with a marker annotation and automatically add the import- Parameters:
clazz
- the class of the annotation- Returns:
- this
-
addSingleMemberAnnotation
default N addSingleMemberAnnotation(String name, Expression expression)
Annotates this with a single member annotation- Parameters:
name
- the name of the annotationexpression
- the part between ()- Returns:
- this
-
addSingleMemberAnnotation
default N addSingleMemberAnnotation(Class<? extends Annotation> clazz, Expression expression)
Annotates this with a single member annotation- Parameters:
clazz
- the class of the annotationexpression
- the part between ()- Returns:
- this
-
addSingleMemberAnnotation
default N addSingleMemberAnnotation(String name, String value)
Annotates this with a single member annotation- Parameters:
name
- the name of the annotationvalue
- the value, don't forget to add \"\" for a string value- Returns:
- this
-
addSingleMemberAnnotation
default N addSingleMemberAnnotation(Class<? extends Annotation> clazz, String value)
Annotates this with a single member annotation and automatically add the import- Parameters:
clazz
- the class of the annotationvalue
- the value, don't forget to add \"\" for a string value- Returns:
- this
-
isAnnotationPresent
default boolean isAnnotationPresent(String annotationName)
Check whether an annotation with this name is present on this element- Parameters:
annotationName
- the name of the annotation- Returns:
- true if found, false if not
-
isAnnotationPresent
default boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
Check whether an annotation with this class is present on this element- Parameters:
annotationClass
- the class of the annotation- Returns:
- true if found, false if not
-
getAnnotationByName
default Optional<AnnotationExpr> getAnnotationByName(String annotationName)
Try to find an annotation by its name- Parameters:
annotationName
- the name of the annotation
-
getAnnotationByClass
default Optional<AnnotationExpr> getAnnotationByClass(Class<? extends Annotation> annotationClass)
Try to find an annotation by its class- Parameters:
annotationClass
- the class of the annotation
-
-