Class JavaParserConstructorDeclaration<N extends ResolvedReferenceTypeDeclaration>

java.lang.Object

com.github.javaparser.symbolsolver.javaparsermodel.declarations.JavaParserConstructorDeclaration<N>

All Implemented Interfaces:

AssociableToAST, HasAccessSpecifier, ResolvedConstructorDeclaration, ResolvedDeclaration, ResolvedMethodLikeDeclaration, ResolvedTypeParametrizable

public class JavaParserConstructorDeclaration<N extends ResolvedReferenceTypeDeclaration>
extends Object
implements ResolvedConstructorDeclaration

Field Summary

Fields

Modifier and Type	Field	Description
private N	declaringType
private TypeSolver	typeSolver
private ConstructorDeclaration	wrappedNode

Constructor Summary

Constructors

Constructor	Description
JavaParserConstructorDeclaration(N declaringType, ConstructorDeclaration wrappedNode, TypeSolver typeSolver)

Method Summary

Modifier and Type	Method	Description
AccessSpecifier	accessSpecifier()	The access specifier of this element.
N	declaringType()	A constructor can be declared in a class or an enum.
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	getSpecifiedException(int index)	Type of the corresponding entry in the throws clause.
List<ResolvedTypeParameterDeclaration>	getTypeParameters()	The list of type parameters defined on this element.
ConstructorDeclaration	getWrappedNode()	Returns the JavaParser node associated with this JavaParserConstructorDeclaration.
Optional<Node>	toAst()	If the declaration is associated to an AST node return it, otherwise it return empty.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 ResolvedMethodLikeDeclaration

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

Methods inherited from interface ResolvedTypeParametrizable

isGeneric

Field Details

declaringType

private N extends ResolvedReferenceTypeDeclaration declaringType

wrappedNode

private ConstructorDeclaration wrappedNode

typeSolver

private TypeSolver typeSolver

Constructor Details

JavaParserConstructorDeclaration

JavaParserConstructorDeclaration(N declaringType,
 ConstructorDeclaration wrappedNode,
 TypeSolver typeSolver)

Method Details

declaringType

public N declaringType()

Description copied from interface: ResolvedConstructorDeclaration

A constructor can be declared in a class or an enum.

Specified by:

declaringType in interface ResolvedConstructorDeclaration

Specified by:

declaringType in interface ResolvedMethodLikeDeclaration

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

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

getWrappedNode

public ConstructorDeclaration getWrappedNode()

Returns the JavaParser node associated with this JavaParserConstructorDeclaration.

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

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

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