Class JavaParserRecordDeclaration

java.lang.Object

com.github.javaparser.symbolsolver.logic.AbstractTypeDeclaration

com.github.javaparser.symbolsolver.javaparsermodel.declarations.JavaParserRecordDeclaration

All Implemented Interfaces:

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

public class JavaParserRecordDeclaration
extends AbstractTypeDeclaration
implements ResolvedRecordDeclaration, MethodResolutionCapability, MethodUsageResolutionCapability, SymbolResolutionCapability

Heavily based on JavaParserClassDeclaration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaParserRecordDeclaration.CanonicalRecordConstructor
static class	JavaParserRecordDeclaration.ImplicitGetterMethod

Field Summary

Fields

Modifier and Type	Field	Description
private JavaParserTypeAdapter<RecordDeclaration>	javaParserTypeAdapter
private TypeSolver	typeSolver	Fields
private RecordDeclaration	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
JavaParserRecordDeclaration(RecordDeclaration wrappedNode, TypeSolver typeSolver)	Constructors

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?
Optional<ResolvedReferenceTypeDeclaration>	containerType()	Get the ReferenceTypeDeclaration enclosing this declaration.
private boolean	containsCanonicalConstructor(List<ResolvedConstructorDeclaration> constructors)
boolean	equals(Object o)	Public methods: from Object
List<ResolvedFieldDeclaration>	getAllFields()	This method returns both the ResolvedFieldDeclarations for the explicit static fields declared in the record and non-static private fields corresponding to the record parameters.
List<ResolvedReferenceType>	getAllInterfaces()	Return all the interfaces implemented by this class, either directly or indirectly, including the interfaces extended by interfaces it implements.
List<ResolvedReferenceType>	getAllSuperClasses()	Get all superclasses, with all the type typeParametersValues expressed as functions of the type typeParametersValues of this declaration.
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.
String	getClassName()	The class(es) wrapping this type.
List<ResolvedConstructorDeclaration>	getConstructors()	List of constructors available for the class.
Context	getContext()	Deprecated.
Set<ResolvedAnnotationDeclaration>	getDeclaredAnnotations()	Return a collection of all annotations declared in this type declaration.
Set<ResolvedMethodDeclaration>	getDeclaredMethods()	This method returns both the explicit methods declared in the record and the implicit getter methods for the record parameters.
List<ResolvedReferenceType>	getInterfaces()	Return all the interfaces implemented directly by this class.
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.
Optional<ResolvedReferenceType>	getSuperClass()	This is a ReferenceTypeUsage because it could contain type typeParametersValues.
List<ResolvedTypeParameterDeclaration>	getTypeParameters()	The list of type parameters defined on this element.
ResolvedType	getUsage(Node node)
RecordDeclaration	getWrappedNode()	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()
Set<ResolvedReferenceTypeDeclaration>	internalTypes()	Protected methods
private boolean	isAncestor(ResolvedReferenceType candidateAncestor, String ownQualifiedName)
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?
SymbolReference<ResolvedMethodDeclaration>	solveMethod(String name, List<ResolvedType> parameterTypes)	Public methods
SymbolReference<ResolvedMethodDeclaration>	solveMethod(String name, List<ResolvedType> argumentsTypes, boolean staticOnly)
Optional<MethodUsage>	solveMethodAsUsage(String name, List<ResolvedType> argumentTypes, Context invocationContext, List<ResolvedType> typeParameters)
SymbolReference<? extends ResolvedValueDeclaration>	solveSymbol(String name, TypeSolver typeSolver)
SymbolReference<ResolvedTypeDeclaration>	solveType(String name)	Deprecated.
Optional<Node>	toAst()	If the declaration is associated to an AST node return it, otherwise it return empty.
private ResolvedReferenceType	toReferenceType(ClassOrInterfaceType classOrInterfaceType)	Private methods
String	toString()

Methods inherited from class AbstractTypeDeclaration

getAllMethods, isFunctionalInterface, isRecordType

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AssociableToAST

toAst

Methods inherited from interface ResolvedDeclaration

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

Methods inherited from interface ResolvedRecordDeclaration

asRecord, isRecord

Methods inherited from interface 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 ResolvedTypeDeclaration

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

Methods inherited from interface ResolvedTypeParametrizable

isGeneric

Field Details

typeSolver

private TypeSolver typeSolver

Fields

wrappedNode

private RecordDeclaration wrappedNode

javaParserTypeAdapter

private JavaParserTypeAdapter<RecordDeclaration> javaParserTypeAdapter

Constructor Details

JavaParserRecordDeclaration

public JavaParserRecordDeclaration(RecordDeclaration wrappedNode,
 TypeSolver typeSolver)

Constructors

Method Details

equals

public boolean equals(Object o)

Public methods: from Object

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getAllFields

public List<ResolvedFieldDeclaration> getAllFields()

This method returns both the ResolvedFieldDeclarations for the explicit static fields declared in the record and non-static private fields corresponding to the record parameters. This is done to make the fields of a record consistent across the various models (since the record parameters are considered fields by the Java compiler and runtime).

Specified by:

getAllFields in interface ResolvedReferenceTypeDeclaration

solveMethod

public SymbolReference<ResolvedMethodDeclaration> solveMethod(String name,
 List<ResolvedType> parameterTypes)

Public methods

solveMethodAsUsage

public Optional<MethodUsage> solveMethodAsUsage(String name,
 List<ResolvedType> argumentTypes,
 Context invocationContext,
 List<ResolvedType> typeParameters)

Specified by:

solveMethodAsUsage in interface MethodUsageResolutionCapability

getContext

@Deprecated
public Context 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

public ResolvedType getUsage(Node node)

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

getSuperClass

public 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

getInterfaces

public 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

getAllSuperClasses

public 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

getAllInterfaces

public 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

getConstructors

public 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

containsCanonicalConstructor

private boolean containsCanonicalConstructor(List<ResolvedConstructorDeclaration> constructors)

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

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

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

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

solveType

@Deprecated
public SymbolReference<ResolvedTypeDeclaration> solveType(String name)

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

solveSymbol

public SymbolReference<? extends ResolvedValueDeclaration> solveSymbol(String name,
 TypeSolver typeSolver)

Specified by:

solveSymbol in interface SymbolResolutionCapability

Parameters:

name - Field / symbol name.

typeSolver - Symbol solver to resolve type usage.

Returns:

Symbol reference of the resolved value.

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.

isAncestor

private boolean isAncestor(ResolvedReferenceType candidateAncestor,
 String ownQualifiedName)

getDeclaredMethods

public Set<ResolvedMethodDeclaration> getDeclaredMethods()

This method returns both the explicit methods declared in the record and the implicit getter methods for the record parameters. This is done for consistency across the various models.

Specified by:

getDeclaredMethods in interface ResolvedReferenceTypeDeclaration

getTypeParameters

public List<ResolvedTypeParameterDeclaration> getTypeParameters()

Description copied from interface: ResolvedTypeParametrizable

The list of type parameters defined on this element.

Specified by:

getTypeParameters in interface ResolvedTypeParametrizable

getWrappedNode

public RecordDeclaration getWrappedNode()

Returns the JavaParser node associated with this JavaParserClassDeclaration.

Returns:

A visitable JavaParser node wrapped by this object.

accessSpecifier

public AccessSpecifier accessSpecifier()

Description copied from interface: HasAccessSpecifier

The access specifier of this element.

Specified by:

accessSpecifier in interface HasAccessSpecifier

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

internalTypes

public Set<ResolvedReferenceTypeDeclaration> internalTypes()

Protected methods

Specified by:

internalTypes in interface ResolvedTypeDeclaration

containerType

public Optional<ResolvedReferenceTypeDeclaration> containerType()

Description copied from interface: ResolvedTypeDeclaration

Get the ReferenceTypeDeclaration enclosing this declaration.

Specified by:

containerType in interface ResolvedTypeDeclaration

toReferenceType

private ResolvedReferenceType toReferenceType(ClassOrInterfaceType classOrInterfaceType)

Private methods