com.github.javaparser.ast.body

Class ConstructorDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.body.BodyDeclaration<ConstructorDeclaration>

com.github.javaparser.ast.body.ConstructorDeclaration

All Implemented Interfaces:

NodeWithAnnotations<ConstructorDeclaration>, NodeWithBlockStmt<ConstructorDeclaration>, NodeWithDeclaration, NodeWithJavaDoc<ConstructorDeclaration>, NodeWithModifiers<ConstructorDeclaration>, NodeWithParameters<ConstructorDeclaration>, NodeWithSimpleName<ConstructorDeclaration>, NodeWithThrownExceptions<ConstructorDeclaration>, NodeWithTypeParameters<ConstructorDeclaration>, Observable, Visitable, HasParentNode<Node>, Cloneable

public final class ConstructorDeclaration
extends BodyDeclaration<ConstructorDeclaration>
implements NodeWithJavaDoc<ConstructorDeclaration>, NodeWithDeclaration, NodeWithSimpleName<ConstructorDeclaration>, NodeWithModifiers<ConstructorDeclaration>, NodeWithParameters<ConstructorDeclaration>, NodeWithThrownExceptions<ConstructorDeclaration>, NodeWithBlockStmt<ConstructorDeclaration>, NodeWithTypeParameters<ConstructorDeclaration>

Author:

Julio Vilmar Gesser

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.ObserverRegistrationMode

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration

Constructor Summary

Constructors

Constructor and Description
ConstructorDeclaration()
ConstructorDeclaration(EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, SimpleName name, NodeList<Parameter> parameters, NodeList<ReferenceType<?>> thrownExceptions, BlockStmt block)
ConstructorDeclaration(EnumSet<Modifier> modifiers, String name)
ConstructorDeclaration(Range range, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, SimpleName name, NodeList<Parameter> parameters, NodeList<ReferenceType<?>> thrownExceptions, BlockStmt block)

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg) Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg) Accept method for visitor support.
BlockStmt	getBody()
String	getDeclarationAsString() As NodeWithDeclaration.getDeclarationAsString(boolean, boolean, boolean) including the modifiers, the throws clause and the parameters with both type and name.
String	getDeclarationAsString(boolean includingModifiers, boolean includingThrows) As NodeWithDeclaration.getDeclarationAsString(boolean, boolean, boolean) including the parameters with both type and name.
String	getDeclarationAsString(boolean includingModifiers, boolean includingThrows, boolean includingParameterName) The declaration returned has this schema: [accessSpecifier] className ([paramType [paramName]]) [throws exceptionsList]
JavadocComment	getJavaDoc() Gets the JavaDoc for this node.
EnumSet<Modifier>	getModifiers() Return the modifiers of this member declaration.
SimpleName	getName()
List<NodeList<?>>	getNodeLists() The list of NodeLists owned by this node.
NodeList<Parameter>	getParameters()
NodeList<ReferenceType<?>>	getThrownExceptions()
NodeList<TypeParameter>	getTypeParameters()
ConstructorDeclaration	setBody(BlockStmt body)
ConstructorDeclaration	setModifiers(EnumSet<Modifier> modifiers)
ConstructorDeclaration	setName(SimpleName name)
ConstructorDeclaration	setParameters(NodeList<Parameter> parameters)
ConstructorDeclaration	setThrownExceptions(NodeList<ReferenceType<?>> thrownExceptions)
ConstructorDeclaration	setTypeParameters(NodeList<TypeParameter> typeParameters)

Methods inherited from class com.github.javaparser.ast.body.BodyDeclaration

getAnnotations, setAnnotations

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, clone, containsWithin, equals, getAllContainedComments, getBegin, getChildNodes, getComment, getData, getEnd, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getRange, hasComment, hashCode, isPositionedAfter, isPositionedBefore, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setRange, toString, toString, tryAddImportToParentCompilationUnit, unregister

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithJavaDoc

setJavaDocComment

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithSimpleName

getNameAsString, setName

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithModifiers

addModifier, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithParameters

addAndGetParameter, addAndGetParameter, addAndGetParameter, addAndGetParameter, addParameter, addParameter, addParameter, addParameter, getParamByName, getParamByType, getParamByType, getParameter

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithThrownExceptions

addThrownException, addThrownException, getThrownException, isThrown, isThrown

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithBlockStmt

createBody

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithTypeParameters

getTypeParameter, isGeneric

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithAnnotations

addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Constructor Detail

ConstructorDeclaration

public ConstructorDeclaration()

ConstructorDeclaration

public ConstructorDeclaration(EnumSet<Modifier> modifiers,
                              String name)

ConstructorDeclaration

public ConstructorDeclaration(EnumSet<Modifier> modifiers,
                              NodeList<AnnotationExpr> annotations,
                              NodeList<TypeParameter> typeParameters,
                              SimpleName name,
                              NodeList<Parameter> parameters,
                              NodeList<ReferenceType<?>> thrownExceptions,
                              BlockStmt block)

ConstructorDeclaration

public ConstructorDeclaration(Range range,
                              EnumSet<Modifier> modifiers,
                              NodeList<AnnotationExpr> annotations,
                              NodeList<TypeParameter> typeParameters,
                              SimpleName name,
                              NodeList<Parameter> parameters,
                              NodeList<ReferenceType<?>> thrownExceptions,
                              BlockStmt block)

Method Detail

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

getModifiers

public EnumSet<Modifier> getModifiers()

Return the modifiers of this member declaration.

Specified by:

getModifiers in interface NodeWithModifiers<ConstructorDeclaration>

Returns:

modifiers

See Also:

Modifier

getName

public SimpleName getName()

Specified by:

getName in interface NodeWithSimpleName<ConstructorDeclaration>

getParameters

public NodeList<Parameter> getParameters()

Specified by:

getParameters in interface NodeWithParameters<ConstructorDeclaration>

getThrownExceptions

public NodeList<ReferenceType<?>> getThrownExceptions()

Specified by:

getThrownExceptions in interface NodeWithThrownExceptions<ConstructorDeclaration>

getTypeParameters

public NodeList<TypeParameter> getTypeParameters()

Specified by:

getTypeParameters in interface NodeWithTypeParameters<ConstructorDeclaration>

setModifiers

public ConstructorDeclaration setModifiers(EnumSet<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<ConstructorDeclaration>

setName

public ConstructorDeclaration setName(SimpleName name)

Specified by:

setName in interface NodeWithSimpleName<ConstructorDeclaration>

setParameters

public ConstructorDeclaration setParameters(NodeList<Parameter> parameters)

Specified by:

setParameters in interface NodeWithParameters<ConstructorDeclaration>

setThrownExceptions

public ConstructorDeclaration setThrownExceptions(NodeList<ReferenceType<?>> thrownExceptions)

Specified by:

setThrownExceptions in interface NodeWithThrownExceptions<ConstructorDeclaration>

setTypeParameters

public ConstructorDeclaration setTypeParameters(NodeList<TypeParameter> typeParameters)

Specified by:

setTypeParameters in interface NodeWithTypeParameters<ConstructorDeclaration>

getDeclarationAsString

public String getDeclarationAsString(boolean includingModifiers,
                                     boolean includingThrows,
                                     boolean includingParameterName)

The declaration returned has this schema: [accessSpecifier] className ([paramType [paramName]]) [throws exceptionsList]

Specified by:

getDeclarationAsString in interface NodeWithDeclaration

Parameters:

includingModifiers - flag to include the modifiers (if present) in the string produced

includingThrows - flag to include the throws clause (if present) in the string produced

includingParameterName - flag to include the parameter name (while the parameter type is always included) in the string produced

Returns:

String representation of declaration based on parameter flags

getDeclarationAsString

public String getDeclarationAsString(boolean includingModifiers,
                                     boolean includingThrows)

Description copied from interface: NodeWithDeclaration

As NodeWithDeclaration.getDeclarationAsString(boolean, boolean, boolean) including the parameters with both type and name.

Specified by:

getDeclarationAsString in interface NodeWithDeclaration

Parameters:

includingModifiers - flag to include the modifiers (if present) in the string produced

includingThrows - flag to include the throws clause (if present) in the string produced

Returns:

String representation of declaration based on parameter flags

getDeclarationAsString

public String getDeclarationAsString()

Description copied from interface: NodeWithDeclaration

As NodeWithDeclaration.getDeclarationAsString(boolean, boolean, boolean) including the modifiers, the throws clause and the parameters with both type and name.

Specified by:

getDeclarationAsString in interface NodeWithDeclaration

Returns:

String representation of declaration

getJavaDoc

public JavadocComment getJavaDoc()

Description copied from interface: NodeWithJavaDoc

Gets the JavaDoc for this node. You can set the JavaDoc by calling setComment with a JavadocComment.

Specified by:

getJavaDoc in interface NodeWithJavaDoc<ConstructorDeclaration>

Returns:

The JavaDoc for this node if it exists, null if it doesn't.

getBody

public BlockStmt getBody()

Specified by:

getBody in interface NodeWithBlockStmt<ConstructorDeclaration>

setBody

public ConstructorDeclaration setBody(BlockStmt body)

Specified by:

setBody in interface NodeWithBlockStmt<ConstructorDeclaration>

getNodeLists

public List<NodeList<?>> getNodeLists()

Description copied from class: Node

The list of NodeLists owned by this node.

Overrides:

getNodeLists in class BodyDeclaration<ConstructorDeclaration>