Class JavaParserClassDeclaration
java.lang.Object
com.github.javaparser.symbolsolver.logic.AbstractTypeDeclaration
com.github.javaparser.symbolsolver.logic.AbstractClassDeclaration
com.github.javaparser.symbolsolver.javaparsermodel.declarations.JavaParserClassDeclaration
- All Implemented Interfaces:
AssociableToAST
,HasAccessSpecifier
,ResolvedClassDeclaration
,ResolvedDeclaration
,ResolvedReferenceTypeDeclaration
,ResolvedTypeDeclaration
,ResolvedTypeParametrizable
,MethodResolutionCapability
,MethodUsageResolutionCapability
,SymbolResolutionCapability
public class JavaParserClassDeclaration
extends AbstractClassDeclaration
implements MethodUsageResolutionCapability, SymbolResolutionCapability
-
Field Summary
FieldsFields inherited from interface com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration
breadthFirstFunc, depthFirstFunc, JAVA_IO_SERIALIZABLE, JAVA_LANG_COMPARABLE, JAVA_LANG_ENUM, JAVA_LANG_OBJECT, JAVA_LANG_RECORD
-
Constructor Summary
ConstructorsConstructorDescriptionJavaParserClassDeclaration
(ClassOrInterfaceDeclaration wrappedNode, TypeSolver typeSolver) -
Method Summary
Modifier and TypeMethodDescriptionThe access specifier of this element.boolean
Can we assign instances of the type defined by this declaration to variables having the type defined by the given type?Get the ReferenceTypeDeclaration enclosing this declaration.boolean
Return a list of all fields, either declared in this declaration or inherited.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.The class(es) wrapping this type.List of constructors available for the class.Deprecated.Return a collection of all annotations declared in this type declaration.Return a list of all the methods declared in this type declaration.Return all the interfaces implemented directly by this class.getName()
Should return the name or return null if the name is not available.The package name of the type.The fully qualified name of the type declared.This is a ReferenceTypeUsage because it could contain type typeParametersValues.The list of type parameters defined on this element.Returns the JavaParser node associated with this JavaParserClassDeclaration.boolean
hasDirectlyAnnotation
(String canonicalName) Has the type at least one annotation declared having the specified qualified name?int
hashCode()
Get the list of types defined inside the current type.private boolean
isAncestor
(ResolvedReferenceType candidateAncestor, String ownQualifiedName) boolean
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
Is this the declaration of an interface?boolean
Is this the declaration of a type parameter?protected ResolvedReferenceType
object()
An implementation of the Object class.solveMethod
(String name, List<ResolvedType> parameterTypes) solveMethod
(String name, List<ResolvedType> argumentsTypes, boolean staticOnly) solveMethodAsUsage
(String name, List<ResolvedType> argumentTypes, Context invocationContext, List<ResolvedType> typeParameters) SymbolReference
<? extends ResolvedValueDeclaration> solveSymbol
(String name, TypeSolver typeSolver) Deprecated.toAst()
If the declaration is associated to an AST node return it, otherwise it return empty.private ResolvedReferenceType
toReferenceType
(ClassOrInterfaceType classOrInterfaceType) toString()
Methods inherited from class com.github.javaparser.symbolsolver.logic.AbstractClassDeclaration
asClass, getAllInterfaces, getAllSuperClasses, hasName
Methods inherited from class com.github.javaparser.symbolsolver.logic.AbstractTypeDeclaration
getAllMethods, isFunctionalInterface, isRecordType
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.github.javaparser.resolution.declarations.AssociableToAST
toAst
Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedClassDeclaration
isClass
Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedDeclaration
asEnumConstant, asField, asMethod, asParameter, asTypePattern, isEnumConstant, isField, isMethod, isParameter, isTypePattern, isVariable
Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration
asReferenceType, 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 com.github.javaparser.resolution.declarations.ResolvedTypeDeclaration
asAnnotation, asEnum, asInterface, asRecord, asType, asTypeParameter, getId, getInternalType, hasInternalType, isAnnotation, isAnonymousClass, isEnum, isRecord, isType
Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedTypeParametrizable
isGeneric
-
Field Details
-
typeSolver
-
wrappedNode
-
javaParserTypeAdapter
-
-
Constructor Details
-
JavaParserClassDeclaration
-
-
Method Details
-
equals
-
hashCode
public int hashCode() -
toString
-
getAllFields
Description copied from interface:ResolvedReferenceTypeDeclaration
Return a list of all fields, either declared in this declaration or inherited.- Specified by:
getAllFields
in interfaceResolvedReferenceTypeDeclaration
-
solveMethod
public SymbolReference<ResolvedMethodDeclaration> solveMethod(String name, List<ResolvedType> parameterTypes) -
solveMethodAsUsage
public Optional<MethodUsage> solveMethodAsUsage(String name, List<ResolvedType> argumentTypes, Context invocationContext, List<ResolvedType> typeParameters) - Specified by:
solveMethodAsUsage
in interfaceMethodUsageResolutionCapability
-
getContext
Deprecated.This method is deprecated because the context is an implementation detail that should not be exposed. Ideally this method should become private. For this reason all further usages of this method are discouraged. -
getUsage
-
getName
Description copied from interface:ResolvedDeclaration
Should return the name or return null if the name is not available.- Specified by:
getName
in interfaceResolvedDeclaration
-
getSuperClass
Description copied from interface:ResolvedClassDeclaration
This is a ReferenceTypeUsage because it could contain type typeParametersValues. For example:class A extends B<Integer, String>
.Note that only the Object class should not have a superclass and therefore return empty.
- Specified by:
getSuperClass
in interfaceResolvedClassDeclaration
-
getInterfaces
Description copied from interface:ResolvedClassDeclaration
Return all the interfaces implemented directly by this class. It does not include the interfaces implemented by superclasses or extended by the interfaces implemented.- Specified by:
getInterfaces
in interfaceResolvedClassDeclaration
-
getConstructors
Description copied from interface:ResolvedClassDeclaration
List of constructors available for the class. This list should also include the default constructor.- Specified by:
getConstructors
in interfaceResolvedClassDeclaration
- Specified by:
getConstructors
in interfaceResolvedReferenceTypeDeclaration
-
hasDirectlyAnnotation
Description copied from interface:ResolvedReferenceTypeDeclaration
Has the type at least one annotation declared having the specified qualified name?- Specified by:
hasDirectlyAnnotation
in interfaceResolvedReferenceTypeDeclaration
-
getDeclaredAnnotations
Description copied from interface:ResolvedReferenceTypeDeclaration
Return a collection of all annotations declared in this type declaration.- Specified by:
getDeclaredAnnotations
in interfaceResolvedReferenceTypeDeclaration
-
isInterface
public boolean isInterface()Description copied from interface:ResolvedTypeDeclaration
Is this the declaration of an interface?- Specified by:
isInterface
in interfaceResolvedTypeDeclaration
-
getPackageName
Description copied from interface:ResolvedTypeDeclaration
The package name of the type.- Specified by:
getPackageName
in interfaceResolvedTypeDeclaration
-
getClassName
Description copied from interface:ResolvedTypeDeclaration
The class(es) wrapping this type.- Specified by:
getClassName
in interfaceResolvedTypeDeclaration
-
getQualifiedName
Description copied from interface:ResolvedTypeDeclaration
The fully qualified name of the type declared.- Specified by:
getQualifiedName
in interfaceResolvedTypeDeclaration
-
isAssignableBy
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 interfaceResolvedReferenceTypeDeclaration
-
isAssignableBy
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 interfaceResolvedReferenceTypeDeclaration
-
canBeAssignedTo
Description copied from interface:ResolvedReferenceTypeDeclaration
Can we assign instances of the type defined by this declaration to variables having the type defined by the given type?- Specified by:
canBeAssignedTo
in interfaceResolvedReferenceTypeDeclaration
-
isTypeParameter
public boolean isTypeParameter()Description copied from interface:ResolvedTypeDeclaration
Is this the declaration of a type parameter?- Specified by:
isTypeParameter
in interfaceResolvedTypeDeclaration
-
solveType
Deprecated.Resolution should move out of declarations, so that they are pure declarations and the resolution should work for JavaParser, Reflection and Javassist classes in the same way and not be specific to the three implementations. -
solveMethod
public SymbolReference<ResolvedMethodDeclaration> solveMethod(String name, List<ResolvedType> argumentsTypes, boolean staticOnly) - Specified by:
solveMethod
in interfaceMethodResolutionCapability
-
solveSymbol
public SymbolReference<? extends ResolvedValueDeclaration> solveSymbol(String name, TypeSolver typeSolver) - Specified by:
solveSymbol
in interfaceSymbolResolutionCapability
- Parameters:
name
- Field / symbol name.typeSolver
- Symbol solver to resolve type usage.- Returns:
- Symbol reference of the resolved value.
-
getAncestors
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
isfalse
, then anUnsolvedSymbolException
is thrown if any ancestor cannot be resolved. Otherwise, a list of only the resolvable direct ancestors is returned.- Specified by:
getAncestors
in interfaceResolvedReferenceTypeDeclaration
- Parameters:
acceptIncompleteList
- When set tofalse
, this method throws anUnsolvedSymbolException
if one or more ancestor could not be resolved. When set totrue
, this method does not throw anUnsolvedSymbolException
, 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.
-
isAncestor
-
getDeclaredMethods
Description copied from interface:ResolvedReferenceTypeDeclaration
Return a list of all the methods declared in this type declaration.- Specified by:
getDeclaredMethods
in interfaceResolvedReferenceTypeDeclaration
-
getTypeParameters
Description copied from interface:ResolvedTypeParametrizable
The list of type parameters defined on this element.- Specified by:
getTypeParameters
in interfaceResolvedTypeParametrizable
-
getWrappedNode
Returns the JavaParser node associated with this JavaParserClassDeclaration.- Returns:
- A visitable JavaParser node wrapped by this object.
-
accessSpecifier
Description copied from interface:HasAccessSpecifier
The access specifier of this element.- Specified by:
accessSpecifier
in interfaceHasAccessSpecifier
-
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 interfaceAssociableToAST
-
object
Description copied from class:AbstractClassDeclaration
An implementation of the Object class.- Specified by:
object
in classAbstractClassDeclaration
-
internalTypes
Description copied from interface:ResolvedTypeDeclaration
Get the list of types defined inside the current type.- Specified by:
internalTypes
in interfaceResolvedTypeDeclaration
-
containerType
Description copied from interface:ResolvedTypeDeclaration
Get the ReferenceTypeDeclaration enclosing this declaration.- Specified by:
containerType
in interfaceResolvedTypeDeclaration
-
toReferenceType
-