JavaParserRecordDeclaration (javaparser-symbol-solver-core 3.27.0 API)

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

Author:

Federico Tomassetti

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JavaParserRecordDeclaration.CanonicalRecordConstructor`
`static class`	`JavaParserRecordDeclaration.ImplicitGetterMethod`

Field Summary
- 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 and Description

JavaParserRecordDeclaration(RecordDeclaration wrappedNode, TypeSolver typeSolver)

Constructors
Constructor and Description
`JavaParserRecordDeclaration(RecordDeclaration wrappedNode, TypeSolver typeSolver)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AccessSpecifier`	`accessSpecifier()`
`boolean`	`canBeAssignedTo(ResolvedReferenceTypeDeclaration other)`
`Optional<ResolvedReferenceTypeDeclaration>`	`containerType()`
`boolean`	`equals(Object o)`
`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()`
`List<ResolvedReferenceType>`	`getAllSuperClasses()`
`List<ResolvedReferenceType>`	`getAncestors(boolean acceptIncompleteList)`
`String`	`getClassName()`
`List<ResolvedConstructorDeclaration>`	`getConstructors()`
`Context`	`getContext()` Deprecated.
`Set<ResolvedAnnotationDeclaration>`	`getDeclaredAnnotations()`
`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()`
`String`	`getName()`
`String`	`getPackageName()`
`String`	`getQualifiedName()`
`Optional<ResolvedReferenceType>`	`getSuperClass()`
`List<ResolvedTypeParameterDeclaration>`	`getTypeParameters()`
`ResolvedType`	`getUsage(Node node)`
`RecordDeclaration`	`getWrappedNode()` Returns the JavaParser node associated with this JavaParserClassDeclaration.
`boolean`	`hasDirectlyAnnotation(String canonicalName)`
`int`	`hashCode()`
`Set<ResolvedReferenceTypeDeclaration>`	`internalTypes()`
`boolean`	`isAssignableBy(ResolvedReferenceTypeDeclaration other)`
`boolean`	`isAssignableBy(ResolvedType type)`
`SymbolReference<ResolvedMethodDeclaration>`	`solveMethod(String name, List<ResolvedType> parameterTypes)`
`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()`
`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.ResolvedRecordDeclaration
asRecord, isRecord

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, asClass, asEnum, asInterface, asType, asTypeParameter, getId, getInternalType, hasInternalType, isAnnotation, isAnonymousClass, isClass, isEnum, isInterface, isType, isTypeParameter

Methods inherited from interface com.github.javaparser.resolution.declarations.ResolvedDeclaration
asEnumConstant, asField, asMethod, asParameter, asTypePattern, hasName, isEnumConstant, isField, isMethod, isParameter, isTypePattern, isVariable

Methods inherited from interface com.github.javaparser.resolution.declarations.AssociableToAST
toAst

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

- Constructor Detail
  - JavaParserRecordDeclaration
```
public JavaParserRecordDeclaration(RecordDeclaration wrappedNode,
                                   TypeSolver typeSolver)
```
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    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)
```
  - 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()
```
    Specified by:
    
    getName in interface ResolvedDeclaration
  - getSuperClass
```
public Optional<ResolvedReferenceType> getSuperClass()
```
    Specified by:
    
    getSuperClass in interface ResolvedRecordDeclaration
  - getInterfaces
```
public List<ResolvedReferenceType> getInterfaces()
```
    Specified by:
    
    getInterfaces in interface ResolvedRecordDeclaration
  - getAllSuperClasses
```
public List<ResolvedReferenceType> getAllSuperClasses()
```
    Specified by:
    
    getAllSuperClasses in interface ResolvedRecordDeclaration
  - getAllInterfaces
```
public List<ResolvedReferenceType> getAllInterfaces()
```
    Specified by:
    
    getAllInterfaces in interface ResolvedRecordDeclaration
  - getConstructors
```
public List<ResolvedConstructorDeclaration> getConstructors()
```
    Specified by:
    
    getConstructors in interface ResolvedRecordDeclaration
    
    Specified by:
    
    getConstructors in interface ResolvedReferenceTypeDeclaration
  - hasDirectlyAnnotation
```
public boolean hasDirectlyAnnotation(String canonicalName)
```
    Specified by:
    
    hasDirectlyAnnotation in interface ResolvedReferenceTypeDeclaration
  - getDeclaredAnnotations
```
public Set<ResolvedAnnotationDeclaration> getDeclaredAnnotations()
```
    Specified by:
    
    getDeclaredAnnotations in interface ResolvedReferenceTypeDeclaration
  - getPackageName
```
public String getPackageName()
```
    Specified by:
    
    getPackageName in interface ResolvedTypeDeclaration
  - getClassName
```
public String getClassName()
```
    Specified by:
    
    getClassName in interface ResolvedTypeDeclaration
  - getQualifiedName
```
public String getQualifiedName()
```
    Specified by:
    
    getQualifiedName in interface ResolvedTypeDeclaration
  - isAssignableBy
```
public boolean isAssignableBy(ResolvedReferenceTypeDeclaration other)
```
    Specified by:
    
    isAssignableBy in interface ResolvedReferenceTypeDeclaration
  - isAssignableBy
```
public boolean isAssignableBy(ResolvedType type)
```
    Specified by:
    
    isAssignableBy in interface ResolvedReferenceTypeDeclaration
  - canBeAssignedTo
```
public boolean canBeAssignedTo(ResolvedReferenceTypeDeclaration other)
```
    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)
```
    Specified by:
    
    getAncestors in interface ResolvedReferenceTypeDeclaration
  - 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()
```
    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()
```
    Specified by:
    
    accessSpecifier in interface HasAccessSpecifier
  - toAst
```
public Optional<Node> toAst()
```
    Specified by:
    
    toAst in interface AssociableToAST
  - internalTypes
```
public Set<ResolvedReferenceTypeDeclaration> internalTypes()
```
    Specified by:
    
    internalTypes in interface ResolvedTypeDeclaration
  - containerType
```
public Optional<ResolvedReferenceTypeDeclaration> containerType()
```
    Specified by:
    
    containerType in interface ResolvedTypeDeclaration

Class JavaParserRecordDeclaration

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.github.javaparser.symbolsolver.logic.AbstractTypeDeclaration

Methods inherited from class java.lang.Object

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

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

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

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

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

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

Constructor Detail

JavaParserRecordDeclaration

Method Detail

equals

hashCode

toString

getAllFields

solveMethod

solveMethodAsUsage

getContext

getUsage

getName

getSuperClass

getInterfaces

getAllSuperClasses

getAllInterfaces

getConstructors

hasDirectlyAnnotation

getDeclaredAnnotations

getPackageName

getClassName

getQualifiedName

isAssignableBy

isAssignableBy

canBeAssignedTo

solveType

solveMethod

solveSymbol

getAncestors

getDeclaredMethods

getTypeParameters

getWrappedNode

accessSpecifier

toAst

internalTypes

containerType