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

ResolvedMethodDeclaration

interface ResolvedMethodDeclaration : ResolvedMethodLikeDeclaration(source)

A declaration of a method (either in an interface, a class, an enum or an annotation).

Author

Federico Tomassetti

Functions

accessSpecifier

abstract fun accessSpecifier(): AccessSpecifier

The access specifier of this element.

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

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

asType

open fun asType(): ResolvedTypeDeclaration

Return this as a TypeDeclaration or throw an UnsupportedOperationException

asTypePattern

open fun asTypePattern(): ResolvedTypePatternDeclaration

Return this as a PatternDeclaration or throw an UnsupportedOperationException

declaringType

abstract fun declaringType(): ResolvedReferenceTypeDeclaration

The type in which the method is declared.

findTypeParameter

open fun findTypeParameter(name: String): Optional<ResolvedTypeParameterDeclaration>

Find the closest TypeParameterDeclaration with the given name.

formalParameterTypes

open fun formalParameterTypes(): List<ResolvedType>

getClassName

open fun getClassName(): String

The class(es) wrapping the declaring type.

getLastParam

open fun getLastParam(): ResolvedParameterDeclaration

Utility method to get the last ParameterDeclaration.

getName

abstract fun getName(): String

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

getNumberOfParams

abstract fun getNumberOfParams(): Int

Number of params.

getNumberOfSpecifiedExceptions

abstract fun getNumberOfSpecifiedExceptions(): Int

Number of exceptions listed in the throws clause.

getPackageName

open fun getPackageName(): String

The package name of the declaring type.

getParam

abstract fun getParam(i: Int): ResolvedParameterDeclaration

Get the ParameterDeclaration at the corresponding position or throw IllegalArgumentException.

getQualifiedName

open fun getQualifiedName(): String

The qualified name of the method composed by the qualfied name of the declaring type followed by a dot and the name of the method.

getQualifiedSignature

open fun getQualifiedSignature(): String

The qualified signature of the method.

getReturnType

abstract fun getReturnType(): ResolvedType

The type of the value returned by the current method.

getSignature

open fun getSignature(): String

The signature of the method.

getSpecifiedException

abstract fun getSpecifiedException(index: Int): ResolvedType

Type of the corresponding entry in the throws clause.

getSpecifiedExceptions

open fun getSpecifiedExceptions(): List<ResolvedType>

getTypeParameters

abstract fun getTypeParameters(): List<ResolvedTypeParameterDeclaration>

The list of type parameters defined on this element.

hasName

open fun hasName(): Boolean

Anonymous classes do not have a name, for example.

hasVariadicParameter

open fun hasVariadicParameter(): Boolean

Has the method or construcor a variadic parameter?

isAbstract

abstract fun isAbstract(): Boolean

Is the method abstract?

isArrayLength

open fun isArrayLength(): Boolean

Does this declaration represent the array length pseudo-field?

isDefaultMethod

abstract fun isDefaultMethod(): Boolean

Is this a default method?

isEnumConstant

open fun isEnumConstant(): Boolean

Does this declaration represents an enum constant?

isField

open fun isField(): Boolean

Does this declaration represents a class field?

isGeneric

open fun isGeneric(): Boolean

isMethod

open fun isMethod(): Boolean

Does this declaration represents a method?

isParameter

open fun isParameter(): Boolean

Does this declaration represents a method parameter?

isReturnTypeSubstituable

open fun isReturnTypeSubstituable(otherResolvedType: ResolvedType): Boolean

isStatic

abstract fun isStatic(): Boolean

isType

open fun isType(): Boolean

Does this declaration represents a type?

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.

toDescriptor

abstract fun toDescriptor(): String