Package com.github.javaparser.symbolsolver.reflectionmodel

Class ReflectionRecordDeclaration

java.lang.Object

com.github.javaparser.symbolsolver.logic.AbstractTypeDeclaration

com.github.javaparser.symbolsolver.reflectionmodel.ReflectionRecordDeclaration

All Implemented Interfaces:

AssociableToAST, HasAccessSpecifier, ResolvedDeclaration, ResolvedRecordDeclaration, ResolvedReferenceTypeDeclaration, ResolvedTypeDeclaration, ResolvedTypeParametrizable, MethodResolutionCapability, MethodUsageResolutionCapability

public class ReflectionRecordDeclaration
extends AbstractTypeDeclaration
implements ResolvedRecordDeclaration, MethodResolutionCapability, MethodUsageResolutionCapability

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Class<?>	clazz
private ReflectionClassAdapter	reflectionClassAdapter
private TypeSolver	typeSolver

Fields 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

Constructors

Constructor	Description
ReflectionRecordDeclaration(java.lang.Class<?> clazz, TypeSolver typeSolver)

Method Summary

Modifier and Type	Method	Description
AccessSpecifier	accessSpecifier()	The access specifier of this element.
boolean	canBeAssignedTo(ResolvedReferenceTypeDeclaration other)	Can we assign instances of the type defined by this declaration to variables having the type defined by the given type?
java.util.Optional<ResolvedReferenceTypeDeclaration>	containerType()	Get the ReferenceTypeDeclaration enclosing this declaration.
boolean	equals(java.lang.Object o)
java.util.List<ResolvedFieldDeclaration>	getAllFields()	Return a list of all fields, either declared in this declaration or inherited.
java.util.List<ResolvedReferenceType>	getAllInterfaces()	Return all the interfaces implemented by this class, either directly or indirectly, including the interfaces extended by interfaces it implements.
java.util.List<ResolvedReferenceType>	getAllSuperClasses()	Get all superclasses, with all the type typeParametersValues expressed as functions of the type typeParametersValues of this declaration.
java.util.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.
java.lang.String	getClassName()	The class(es) wrapping this type.
java.util.List<ResolvedConstructorDeclaration>	getConstructors()	List of constructors available for the class.
java.util.Set<ResolvedMethodDeclaration>	getDeclaredMethods()	Return a list of all the methods declared in this type declaration.
ResolvedFieldDeclaration	getField(java.lang.String name)	Note that the type of the field should be expressed using the type variables of this particular type.
java.util.List<ResolvedReferenceType>	getInterfaces()	Return all the interfaces implemented directly by this class.
java.lang.String	getName()	Should return the name or return null if the name is not available.
java.lang.String	getPackageName()	The package name of the type.
java.lang.String	getQualifiedName()	The fully qualified name of the type declared.
java.util.Optional<ResolvedReferenceType>	getSuperClass()	This is a ReferenceTypeUsage because it could contain type typeParametersValues.
java.util.List<ResolvedTypeParameterDeclaration>	getTypeParameters()	The list of type parameters defined on this element.
ResolvedType	getUsage(Node node)
boolean	hasDirectlyAnnotation(java.lang.String canonicalName)	Has the type at least one annotation declared having the specified qualified name?
boolean	hasField(java.lang.String name)	Has this type a field with the given name?
int	hashCode()
java.util.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	isField()	Does this declaration represents a class field?
boolean	isInterface()	Is this the declaration of an interface?
boolean	isParameter()	Does this declaration represents a method parameter?
boolean	isRecord()	Is this the declaration of a record class?
boolean	isType()	Does this declaration represents a type?
boolean	isTypeParameter()	Is this the declaration of a type parameter?
protected ResolvedReferenceType	object()
protected ResolvedReferenceType	record()
SymbolReference<ResolvedMethodDeclaration>	solveMethod(java.lang.String name, java.util.List<ResolvedType> argumentsTypes, boolean staticOnly)	Deprecated.
java.util.Optional<MethodUsage>	solveMethodAsUsage(java.lang.String name, java.util.List<ResolvedType> argumentsTypes, Context invokationContext, java.util.List<ResolvedType> typeParameterValues)
SymbolReference<? extends ResolvedValueDeclaration>	solveSymbol(java.lang.String name, TypeSolver typeSolver)	Deprecated.
java.util.Optional<Node>	toAst()	If the declaration is associated to an AST node return it, otherwise it return empty.
java.lang.String	toString()

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.ResolvedDeclaration

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

Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedRecordDeclaration

asRecord

Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedReferenceTypeDeclaration

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

Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedTypeDeclaration

asAnnotation, asClass, asEnum, asInterface, asType, asTypeParameter, getId, getInternalType, hasInternalType, isAnnotation, isAnonymousClass, isClass, isEnum

Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedTypeParametrizable

isGeneric

Field Detail

clazz

private java.lang.Class<?> clazz

typeSolver

private TypeSolver typeSolver

reflectionClassAdapter

private ReflectionClassAdapter reflectionClassAdapter

Constructor Detail

ReflectionRecordDeclaration

public ReflectionRecordDeclaration(java.lang.Class<?> clazz,
                                   TypeSolver typeSolver)

Method Detail

getDeclaredMethods

public java.util.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

getAncestors

public java.util.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.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getPackageName

public java.lang.String getPackageName()

Description copied from interface: ResolvedTypeDeclaration

The package name of the type.

Specified by:

getPackageName in interface ResolvedTypeDeclaration

getClassName

public java.lang.String getClassName()

Description copied from interface: ResolvedTypeDeclaration

The class(es) wrapping this type.

Specified by:

getClassName in interface ResolvedTypeDeclaration

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: ResolvedTypeDeclaration

The fully qualified name of the type declared.

Specified by:

getQualifiedName in interface ResolvedTypeDeclaration

solveMethod

@Deprecated
public SymbolReference<ResolvedMethodDeclaration> solveMethod(java.lang.String name,
                                                              java.util.List<ResolvedType> argumentsTypes,
                                                              boolean staticOnly)

Deprecated.

Specified by:

solveMethod in interface MethodResolutionCapability

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getUsage

public ResolvedType getUsage(Node node)

solveMethodAsUsage

public java.util.Optional<MethodUsage> solveMethodAsUsage(java.lang.String name,
                                                          java.util.List<ResolvedType> argumentsTypes,
                                                          Context invokationContext,
                                                          java.util.List<ResolvedType> typeParameterValues)

Specified by:

solveMethodAsUsage in interface MethodUsageResolutionCapability

canBeAssignedTo

public boolean canBeAssignedTo(ResolvedReferenceTypeDeclaration other)

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 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

isTypeParameter

public boolean isTypeParameter()

Description copied from interface: ResolvedTypeDeclaration

Is this the declaration of a type parameter?

Specified by:

isTypeParameter in interface ResolvedTypeDeclaration

getField

public ResolvedFieldDeclaration getField(java.lang.String name)

Description copied from interface: ResolvedReferenceTypeDeclaration

Note that the type of the field should be expressed using the type variables of this particular type. Consider for example:

class Foo { E field; }

class Bar extends Foo { }

When calling getField("field") on Foo I should get a FieldDeclaration with type E, while calling it on Bar I should get a FieldDeclaration with type String.

Specified by:

getField in interface ResolvedReferenceTypeDeclaration

getAllFields

public java.util.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

solveSymbol

@Deprecated
public SymbolReference<? extends ResolvedValueDeclaration> solveSymbol(java.lang.String name,
                                                                       TypeSolver typeSolver)

Deprecated.

hasDirectlyAnnotation

public boolean hasDirectlyAnnotation(java.lang.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

hasField

public boolean hasField(java.lang.String name)

Description copied from interface: ResolvedReferenceTypeDeclaration

Has this type a field with the given name?

Specified by:

hasField 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

getName

public java.lang.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

isField

public boolean isField()

Description copied from interface: ResolvedDeclaration

Does this declaration represents a class field?

Specified by:

isField in interface ResolvedDeclaration

isParameter

public boolean isParameter()

Description copied from interface: ResolvedDeclaration

Does this declaration represents a method parameter?

Specified by:

isParameter in interface ResolvedDeclaration

isType

public boolean isType()

Description copied from interface: ResolvedDeclaration

Does this declaration represents a type?

Specified by:

isType in interface ResolvedDeclaration

Specified by:

isType in interface ResolvedTypeDeclaration

isRecord

public boolean isRecord()

Description copied from interface: ResolvedTypeDeclaration

Is this the declaration of a record class?

Specified by:

isRecord in interface ResolvedRecordDeclaration

Specified by:

isRecord in interface ResolvedTypeDeclaration

getSuperClass

public java.util.Optional<ResolvedReferenceType> getSuperClass()

Description copied from interface: ResolvedRecordDeclaration

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 interface ResolvedRecordDeclaration

getAllSuperClasses

public java.util.List<ResolvedReferenceType> getAllSuperClasses()

Description copied from interface: ResolvedRecordDeclaration

Get all superclasses, with all the type typeParametersValues expressed as functions of the type typeParametersValues of this declaration.

Specified by:

getAllSuperClasses in interface ResolvedRecordDeclaration

getInterfaces

public java.util.List<ResolvedReferenceType> getInterfaces()

Description copied from interface: ResolvedRecordDeclaration

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 interface ResolvedRecordDeclaration

getAllInterfaces

public java.util.List<ResolvedReferenceType> getAllInterfaces()

Description copied from interface: ResolvedRecordDeclaration

Return all the interfaces implemented by this class, either directly or indirectly, including the interfaces extended by interfaces it implements.

Get all interfaces, with all the type typeParametersValues expressed as functions of the type typeParametersValues of this declaration.

Specified by:

getAllInterfaces in interface ResolvedRecordDeclaration

isInterface

public boolean isInterface()

Description copied from interface: ResolvedTypeDeclaration

Is this the declaration of an interface?

Specified by:

isInterface in interface ResolvedTypeDeclaration

getTypeParameters

public java.util.List<ResolvedTypeParameterDeclaration> getTypeParameters()

Description copied from interface: ResolvedTypeParametrizable

The list of type parameters defined on this element.

Specified by:

getTypeParameters in interface ResolvedTypeParametrizable

accessSpecifier

public AccessSpecifier accessSpecifier()

Description copied from interface: HasAccessSpecifier

The access specifier of this element.

Specified by:

accessSpecifier in interface HasAccessSpecifier

getConstructors

public java.util.List<ResolvedConstructorDeclaration> getConstructors()

Description copied from interface: ResolvedRecordDeclaration

List of constructors available for the class. This list should also include the default constructor.

Specified by:

getConstructors in interface ResolvedRecordDeclaration

Specified by:

getConstructors in interface ResolvedReferenceTypeDeclaration

containerType

public java.util.Optional<ResolvedReferenceTypeDeclaration> containerType()

Description copied from interface: ResolvedTypeDeclaration

Get the ReferenceTypeDeclaration enclosing this declaration.

Specified by:

containerType in interface ResolvedTypeDeclaration

internalTypes

public java.util.Set<ResolvedReferenceTypeDeclaration> internalTypes()

Description copied from interface: ResolvedTypeDeclaration

Get the list of types defined inside the current type.

Specified by:

internalTypes in interface ResolvedTypeDeclaration

toAst

public java.util.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

record

protected ResolvedReferenceType record()

object

protected ResolvedReferenceType object()