Class JavaParserMethodDeclaration

java.lang.Object

com.github.javaparser.symbolsolver.javaparsermodel.declarations.JavaParserMethodDeclaration

All Implemented Interfaces:

AssociableToAST, HasAccessSpecifier, ResolvedDeclaration, ResolvedMethodDeclaration, ResolvedMethodLikeDeclaration, ResolvedTypeParametrizable, TypeVariableResolutionCapability

public class JavaParserMethodDeclaration
extends Object
implements ResolvedMethodDeclaration, TypeVariableResolutionCapability

Field Summary

Fields

Modifier and Type	Field	Description
private TypeSolver	typeSolver
private MethodDeclaration	wrappedNode

Constructor Summary

Constructors

Constructor	Description
JavaParserMethodDeclaration(MethodDeclaration wrappedNode, TypeSolver typeSolver)

Method Summary

Modifier and Type	Method	Description
AccessSpecifier	accessSpecifier()	The access specifier of this element.
ResolvedReferenceTypeDeclaration	declaringType()	The type in which the method is declared.
private Context	getContext()
String	getName()	Should return the name or return null if the name is not available.
int	getNumberOfParams()	Number of params.
int	getNumberOfSpecifiedExceptions()	Number of exceptions listed in the throws clause.
ResolvedParameterDeclaration	getParam(int i)	Get the ParameterDeclaration at the corresponding position or throw IllegalArgumentException.
ResolvedType	getReturnType()	The type of the value returned by the current method.
ResolvedType	getSpecifiedException(int index)	Type of the corresponding entry in the throws clause.
List<ResolvedTypeParameterDeclaration>	getTypeParameters()	The list of type parameters defined on this element.
MethodUsage	getUsage(Node node)
MethodDeclaration	getWrappedNode()	Returns the JavaParser node associated with this JavaParserMethodDeclaration.
boolean	isAbstract()	Is the method abstract? All interface methods not marked as default are abstract.
boolean	isDefaultMethod()	Is this a default method?
boolean	isStatic()
MethodUsage	resolveTypeVariables(Context context, List<ResolvedType> parameterTypes)
private SymbolResolver	symbolResolver(TypeSolver typeSolver)
Optional<Node>	toAst()	If the declaration is associated to an AST node return it, otherwise it return empty.
String	toDescriptor()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface AssociableToAST

toAst

Methods inherited from interface ResolvedDeclaration

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

Methods inherited from interface ResolvedMethodDeclaration

isReturnTypeSubstituable

Methods inherited from interface ResolvedMethodLikeDeclaration

findTypeParameter, formalParameterTypes, getClassName, getLastParam, getPackageName, getQualifiedName, getQualifiedSignature, getSignature, getSpecifiedExceptions, hasVariadicParameter

Methods inherited from interface ResolvedTypeParametrizable

isGeneric

Field Details

wrappedNode

private MethodDeclaration wrappedNode

typeSolver

private TypeSolver typeSolver

Constructor Details

JavaParserMethodDeclaration

public JavaParserMethodDeclaration(MethodDeclaration wrappedNode,
 TypeSolver typeSolver)

Method Details

toString

public String toString()

Overrides:

toString in class Object

declaringType

public ResolvedReferenceTypeDeclaration declaringType()

Description copied from interface: ResolvedMethodLikeDeclaration

The type in which the method is declared.

Specified by:

declaringType in interface ResolvedMethodLikeDeclaration

symbolResolver

private SymbolResolver symbolResolver(TypeSolver typeSolver)

getReturnType

public ResolvedType getReturnType()

Description copied from interface: ResolvedMethodDeclaration

The type of the value returned by the current method. This method can also be invoked for methods returning void.

Specified by:

getReturnType in interface ResolvedMethodDeclaration

getNumberOfParams

public int getNumberOfParams()

Description copied from interface: ResolvedMethodLikeDeclaration

Number of params.

Specified by:

getNumberOfParams in interface ResolvedMethodLikeDeclaration

getParam

public ResolvedParameterDeclaration getParam(int i)

Description copied from interface: ResolvedMethodLikeDeclaration

Get the ParameterDeclaration at the corresponding position or throw IllegalArgumentException.

Specified by:

getParam in interface ResolvedMethodLikeDeclaration

getUsage

public MethodUsage getUsage(Node node)

resolveTypeVariables

public MethodUsage resolveTypeVariables(Context context,
 List<ResolvedType> parameterTypes)

Specified by:

resolveTypeVariables in interface TypeVariableResolutionCapability

getContext

private Context getContext()

isAbstract

public boolean isAbstract()

Description copied from interface: ResolvedMethodDeclaration

Is the method abstract? All interface methods not marked as default are abstract.

Specified by:

isAbstract in interface ResolvedMethodDeclaration

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

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

isDefaultMethod

public boolean isDefaultMethod()

Description copied from interface: ResolvedMethodDeclaration

Is this a default method?

Specified by:

isDefaultMethod in interface ResolvedMethodDeclaration

isStatic

public boolean isStatic()

Specified by:

isStatic in interface ResolvedMethodDeclaration

getWrappedNode

public MethodDeclaration getWrappedNode()

Returns the JavaParser node associated with this JavaParserMethodDeclaration.

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

getNumberOfSpecifiedExceptions

public int getNumberOfSpecifiedExceptions()

Description copied from interface: ResolvedMethodLikeDeclaration

Number of exceptions listed in the throws clause.

Specified by:

getNumberOfSpecifiedExceptions in interface ResolvedMethodLikeDeclaration

getSpecifiedException

public ResolvedType getSpecifiedException(int index)

Description copied from interface: ResolvedMethodLikeDeclaration

Type of the corresponding entry in the throws clause.

Specified by:

getSpecifiedException in interface ResolvedMethodLikeDeclaration

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

toDescriptor

public String toDescriptor()

Specified by:

toDescriptor in interface ResolvedMethodDeclaration