Class JavaParserAnnotationDeclaration

java.lang.Object

com.github.javaparser.symbolsolver.logic.AbstractTypeDeclaration

com.github.javaparser.symbolsolver.javaparsermodel.declarations.JavaParserAnnotationDeclaration

All Implemented Interfaces:

AssociableToAST, ResolvedAnnotationDeclaration, ResolvedDeclaration, ResolvedReferenceTypeDeclaration, ResolvedTypeDeclaration, ResolvedTypeParametrizable

public class JavaParserAnnotationDeclaration
extends AbstractTypeDeclaration
implements ResolvedAnnotationDeclaration

Field Summary

Fields

Modifier and Type	Field	Description
private JavaParserTypeAdapter<AnnotationDeclaration>	javaParserTypeAdapter
private TypeSolver	typeSolver
private AnnotationDeclaration	wrappedNode

Fields inherited from interface ResolvedReferenceTypeDeclaration

breadthFirstFunc, depthFirstFunc, JAVA_IO_SERIALIZABLE, JAVA_LANG_COMPARABLE, JAVA_LANG_ENUM, JAVA_LANG_OBJECT, JAVA_LANG_RECORD

Constructor Summary

Constructors

Constructor	Description
JavaParserAnnotationDeclaration(AnnotationDeclaration wrappedNode, TypeSolver typeSolver)

Method Summary

Modifier and Type	Method	Description
Optional<ResolvedReferenceTypeDeclaration>	containerType()	Get the ReferenceTypeDeclaration enclosing this declaration.
List<ResolvedFieldDeclaration>	getAllFields()	Return a list of all fields, either declared in this declaration or inherited.
List<ResolvedReferenceType>	getAncestors(boolean acceptIncompleteList)	Resolves the types of all direct ancestors (i.e., the directly extended class and the directly implemented interfaces) and returns the list of ancestors as a list of resolved reference types.
List<ResolvedAnnotationMemberDeclaration>	getAnnotationMembers()
String	getClassName()	The class(es) wrapping this type.
List<ResolvedConstructorDeclaration>	getConstructors()
Set<ResolvedAnnotationDeclaration>	getDeclaredAnnotations()	Return a collection of all annotations declared in this type declaration.
Set<ResolvedMethodDeclaration>	getDeclaredMethods()	Return a list of all the methods declared in this type declaration.
String	getName()	Should return the name or return null if the name is not available.
String	getPackageName()	The package name of the type.
String	getQualifiedName()	The fully qualified name of the type declared.
List<ResolvedTypeParameterDeclaration>	getTypeParameters()	Annotation declarations cannot have type parameters and hence this method always returns an empty list.
boolean	hasDirectlyAnnotation(String canonicalName)	Has the type at least one annotation declared having the specified qualified name?
Set<ResolvedReferenceTypeDeclaration>	internalTypes()	Get the list of types defined inside the current type.
boolean	isAssignableBy(ResolvedReferenceTypeDeclaration other)	Can we assign instances of the given type to variables having the type defined by this declaration?
boolean	isAssignableBy(ResolvedType type)	Can we assign instances of the given type to variables having the type defined by this declaration?
boolean	isInheritable()
Optional<Node>	toAst()	If the declaration is associated to an AST node return it, otherwise it return empty.

Methods inherited from class AbstractTypeDeclaration

getAllMethods, isFunctionalInterface, isRecordType

Methods inherited from class Object

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

Methods inherited from interface AssociableToAST

toAst

Methods inherited from interface ResolvedAnnotationDeclaration

asAnnotation, isAnnotation

Methods inherited from interface ResolvedDeclaration

asEnumConstant, asField, asMethod, asParameter, asTypePattern, hasName, isEnumConstant, isField, isMethod, isParameter, isTypePattern, isVariable

Methods inherited from interface ResolvedReferenceTypeDeclaration

asReferenceType, canBeAssignedTo, findTypeParameter, getAllAncestors, getAllAncestors, getAllMethods, getAllNonStaticFields, getAllStaticFields, getAncestors, getDeclaredAnnotation, getDeclaredFields, getField, getVisibleField, getVisibleFields, hasAnnotation, hasField, hasVisibleField, isFunctionalInterface, isInheritedAnnotation, isJavaLangEnum, isJavaLangObject, isJavaLangRecord, isReferenceType

Methods inherited from interface ResolvedTypeDeclaration

asClass, asEnum, asInterface, asRecord, asType, asTypeParameter, getId, getInternalType, hasInternalType, isAnonymousClass, isClass, isEnum, isInterface, isRecord, isType, isTypeParameter

Methods inherited from interface ResolvedTypeParametrizable

isGeneric

Field Details

wrappedNode

private AnnotationDeclaration wrappedNode

typeSolver

private TypeSolver typeSolver

javaParserTypeAdapter

private JavaParserTypeAdapter<AnnotationDeclaration> javaParserTypeAdapter

Constructor Details

JavaParserAnnotationDeclaration

public JavaParserAnnotationDeclaration(AnnotationDeclaration wrappedNode,
 TypeSolver typeSolver)

Method Details

getAncestors

public List<ResolvedReferenceType> getAncestors(boolean acceptIncompleteList)

Description copied from interface: ResolvedReferenceTypeDeclaration

Resolves the types of all direct ancestors (i.e., the directly extended class and the directly implemented interfaces) and returns the list of ancestors as a list of resolved reference types.

If acceptIncompleteList is false, then an UnsolvedSymbolException is thrown if any ancestor cannot be resolved. Otherwise, a list of only the resolvable direct ancestors is returned.

Specified by:

getAncestors in interface ResolvedReferenceTypeDeclaration

Parameters:

acceptIncompleteList - When set to false, this method throws an UnsolvedSymbolException if one or more ancestor could not be resolved. When set to true, this method does not throw an UnsolvedSymbolException, but the list of returned ancestors may be incomplete in case one or more ancestor could not be resolved.

Returns:

The list of resolved ancestors.

internalTypes

public Set<ResolvedReferenceTypeDeclaration> internalTypes()

Description copied from interface: ResolvedTypeDeclaration

Get the list of types defined inside the current type.

Specified by:

internalTypes in interface ResolvedTypeDeclaration

getAllFields

public List<ResolvedFieldDeclaration> getAllFields()

Description copied from interface: ResolvedReferenceTypeDeclaration

Return a list of all fields, either declared in this declaration or inherited.

Specified by:

getAllFields in interface ResolvedReferenceTypeDeclaration

getDeclaredMethods

public Set<ResolvedMethodDeclaration> getDeclaredMethods()

Description copied from interface: ResolvedReferenceTypeDeclaration

Return a list of all the methods declared in this type declaration.

Specified by:

getDeclaredMethods in interface ResolvedReferenceTypeDeclaration

isAssignableBy

public boolean isAssignableBy(ResolvedType type)

Description copied from interface: ResolvedReferenceTypeDeclaration

Can we assign instances of the given type to variables having the type defined by this declaration?

Specified by:

isAssignableBy in interface ResolvedReferenceTypeDeclaration

isAssignableBy

public boolean isAssignableBy(ResolvedReferenceTypeDeclaration other)

Description copied from interface: ResolvedReferenceTypeDeclaration

Can we assign instances of the given type to variables having the type defined by this declaration?

Specified by:

isAssignableBy in interface ResolvedReferenceTypeDeclaration

hasDirectlyAnnotation

public boolean hasDirectlyAnnotation(String canonicalName)

Description copied from interface: ResolvedReferenceTypeDeclaration

Has the type at least one annotation declared having the specified qualified name?

Specified by:

hasDirectlyAnnotation in interface ResolvedReferenceTypeDeclaration

getDeclaredAnnotations

public Set<ResolvedAnnotationDeclaration> getDeclaredAnnotations()

Description copied from interface: ResolvedReferenceTypeDeclaration

Return a collection of all annotations declared in this type declaration.

Specified by:

getDeclaredAnnotations in interface ResolvedReferenceTypeDeclaration

getPackageName

public String getPackageName()

Description copied from interface: ResolvedTypeDeclaration

The package name of the type.

Specified by:

getPackageName in interface ResolvedTypeDeclaration

getClassName

public String getClassName()

Description copied from interface: ResolvedTypeDeclaration

The class(es) wrapping this type.

Specified by:

getClassName in interface ResolvedTypeDeclaration

getQualifiedName

public String getQualifiedName()

Description copied from interface: ResolvedTypeDeclaration

The fully qualified name of the type declared.

Specified by:

getQualifiedName in interface ResolvedTypeDeclaration

getName

public String getName()

Description copied from interface: ResolvedDeclaration

Should return the name or return null if the name is not available.

Specified by:

getName in interface ResolvedDeclaration

getTypeParameters

public List<ResolvedTypeParameterDeclaration> getTypeParameters()

Annotation declarations cannot have type parameters and hence this method always returns an empty list.

Specified by:

getTypeParameters in interface ResolvedTypeParametrizable

Returns:

An empty list.

containerType

public Optional<ResolvedReferenceTypeDeclaration> containerType()

Description copied from interface: ResolvedTypeDeclaration

Get the ReferenceTypeDeclaration enclosing this declaration.

Specified by:

containerType in interface ResolvedTypeDeclaration

getAnnotationMembers

public List<ResolvedAnnotationMemberDeclaration> getAnnotationMembers()

Specified by:

getAnnotationMembers in interface ResolvedAnnotationDeclaration

getConstructors

public List<ResolvedConstructorDeclaration> getConstructors()

Specified by:

getConstructors in interface ResolvedReferenceTypeDeclaration

isInheritable

public boolean isInheritable()

Specified by:

isInheritable in interface ResolvedAnnotationDeclaration

toAst

public Optional<Node> toAst()

Description copied from interface: AssociableToAST

If the declaration is associated to an AST node return it, otherwise it return empty. Declaration based on source code have an AST node associated while others don't. Example of other declarations are declarations coming from reflection or JARs. You may wonder how this method is different from the various getWrappedNode. The difference is that toAst is present in all Resolved* declarations (such as ResolvedAnnotationDeclaration), while getWrappedNode is present only on the subclasses of the Resolved* declarations that derive from JP AST nodes (such as JavaParserClassDeclaration). Therefore one which has a Resolved* declaration need to do a downcast before being able to use getWrappedNode. Now, this means that toAst could potentially replace getWrappedNode (but not the other way around!). However toAst return an Optional, which is less convenient than getting the direct node. Also, toAst sometimes have to return a more generic node. This is the case for subclasses of ResolvedClassDeclaration. In those cases toAst return a Node. Why? Because both anonymous class declarations and standard class declarations are subclasses of that. In one case the underlying AST node is an ObjectCreationExpr, while in the other case it is ClassOrInterfaceDeclaration. In these cases getWrappedNode is particularly nice because it returns the right type of AST node, not just a Node.

Specified by:

toAst in interface AssociableToAST