jmlparser-core/com.github.javaparser.resolution.declarations/ResolvedTypeDeclaration

ResolvedTypeDeclaration

interface ResolvedTypeDeclaration : ResolvedDeclaration(source)

A declaration of a type. It could be a primitive type, an enum, a class, an interface or a type variable. It cannot be an annotation or an array.

Author

Federico Tomassetti

Inheritors

ResolvedTypeParameterDeclaration

ResolvedReferenceTypeDeclaration

Functions

asAnnotation

open fun asAnnotation(): ResolvedAnnotationDeclaration

Return this as a AnnotationDeclaration or throw UnsupportedOperationException.

asClass

open fun asClass(): ResolvedClassDeclaration

Return this as a ClassDeclaration or throw UnsupportedOperationException.

asEnum

open fun asEnum(): ResolvedEnumDeclaration

Return this as a EnumDeclaration or throw UnsupportedOperationException.

asEnumConstant

open fun asEnumConstant(): ResolvedEnumConstantDeclaration

Return this as a EnumConstantDeclaration or throw an UnsupportedOperationException

asField

open fun asField(): ResolvedFieldDeclaration

Return this as a FieldDeclaration or throw an UnsupportedOperationException

asInterface

open fun asInterface(): ResolvedInterfaceDeclaration

Return this as a InterfaceDeclaration or throw UnsupportedOperationException.

asMethod

open fun asMethod(): ResolvedMethodDeclaration

Return this as a MethodDeclaration or throw an UnsupportedOperationException // FIXME: This is never overridden.

asParameter

open fun asParameter(): ResolvedParameterDeclaration

Return this as a ParameterDeclaration or throw an UnsupportedOperationException

asRecord

open fun asRecord(): ResolvedRecordDeclaration

Return this as a RecordDeclaration or throw UnsupportedOperationException.

asReferenceType

open fun asReferenceType(): ResolvedReferenceTypeDeclaration

asType

open fun asType(): ResolvedTypeDeclaration

Return this as a TypeDeclaration or throw an UnsupportedOperationException

asTypeParameter

open fun asTypeParameter(): ResolvedTypeParameterDeclaration

Return this as a TypeParameterDeclaration or throw UnsupportedOperationException.

asTypePattern

open fun asTypePattern(): ResolvedTypePatternDeclaration

Return this as a PatternDeclaration or throw an UnsupportedOperationException

containerType

abstract fun containerType(): Optional<ResolvedReferenceTypeDeclaration>

Get the ReferenceTypeDeclaration enclosing this declaration.

getClassName

abstract fun getClassName(): String

The class(es) wrapping this type.

getId

open fun getId(): String

The ID corresponds most of the type to the qualified name.

getInternalType

open fun getInternalType(name: String): ResolvedReferenceTypeDeclaration

Returns a type declaration for the internal type based on name.

getName

abstract fun getName(): String

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

getPackageName

abstract fun getPackageName(): String

The package name of the type.

getQualifiedName

abstract fun getQualifiedName(): String

The fully qualified name of the type declared.

hasInternalType

open fun hasInternalType(name: String): Boolean

Does this type contain an internal type with the given name?

hasName

open fun hasName(): Boolean

Anonymous classes do not have a name, for example.

internalTypes

open fun internalTypes(): Set<ResolvedReferenceTypeDeclaration>

Get the list of types defined inside the current type.

isAnnotation

open fun isAnnotation(): Boolean

Is this the declaration of an annotation?

isAnonymousClass

open fun isAnonymousClass(): Boolean

Is this type declaration corresponding to an anonymous class?

isArrayLength

open fun isArrayLength(): Boolean

Does this declaration represent the array length pseudo-field?

isClass

open fun isClass(): Boolean

Is this the declaration of a class?

isEnum

open fun isEnum(): Boolean

Is this the declaration of an enum?

isEnumConstant

open fun isEnumConstant(): Boolean

Does this declaration represents an enum constant?

isField

open fun isField(): Boolean

Does this declaration represents a class field?

isInterface

open fun isInterface(): Boolean

Is this the declaration of an interface?

isMethod

open fun isMethod(): Boolean

Does this declaration represents a method?

isParameter

open fun isParameter(): Boolean

Does this declaration represents a method parameter?

isRecord

open fun isRecord(): Boolean

Is this the declaration of a record class?

isReferenceType

open fun isReferenceType(): Boolean

Is this the declaration of a reference type?

isType

open fun isType(): Boolean

Does this declaration represents a type?

isTypeParameter

open fun isTypeParameter(): Boolean

Is this the declaration of a type parameter?

isTypePattern

open fun isTypePattern(): Boolean

Does this declaration represents a pattern declaration?

isVariable

open fun isVariable(): Boolean

Does this declaration represents a variable?

toAst

open fun toAst(): Optional<Node>

If the declaration is associated to an AST node return it, otherwise it return empty.

open fun <N : Node?> toAst(clazz: Class<N>): Optional<N>

If the declaration is associated to an AST node and the type matches the expected Class return it, otherwise it returns empty.