com.github.javaparser.ast.body

Class MethodDeclaration

java.lang.Object

com.github.javaparser.ast.Node

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

com.github.javaparser.ast.body.MethodDeclaration

All Implemented Interfaces:

NodeWithAnnotations<MethodDeclaration>, NodeWithBlockStmt<MethodDeclaration>, NodeWithDeclaration, NodeWithElementType<MethodDeclaration>, NodeWithJavaDoc<MethodDeclaration>, NodeWithModifiers<MethodDeclaration>, NodeWithName<MethodDeclaration>, NodeWithParameters<MethodDeclaration>, NodeWithThrowable<MethodDeclaration>, NodeWithType<MethodDeclaration>, Cloneable

public final class MethodDeclaration
extends BodyDeclaration<MethodDeclaration>
implements NodeWithJavaDoc<MethodDeclaration>, NodeWithDeclaration, NodeWithName<MethodDeclaration>, NodeWithType<MethodDeclaration>, NodeWithElementType<MethodDeclaration>, NodeWithModifiers<MethodDeclaration>, NodeWithParameters<MethodDeclaration>, NodeWithThrowable<MethodDeclaration>, NodeWithBlockStmt<MethodDeclaration>

Author:

Julio Vilmar Gesser

Field Summary

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE

Constructor Summary

Constructors

Constructor and Description
MethodDeclaration()
MethodDeclaration(EnumSet<Modifier> modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type elementType, List<ArrayBracketPair> arrayBracketPairsAfterElementType, String name, List<Parameter> parameters, List<ArrayBracketPair> arrayBracketPairsAfterParameterList, List<ReferenceType> throws_, BlockStmt body)
MethodDeclaration(EnumSet<Modifier> modifiers, Type elementType, String name)
MethodDeclaration(EnumSet<Modifier> modifiers, Type elementType, String name, List<Parameter> parameters)
MethodDeclaration(Range range, EnumSet<Modifier> modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type elementType, List<ArrayBracketPair> arrayBracketPairsAfterElementType, NameExpr nameExpr, List<Parameter> parameters, List<ArrayBracketPair> arrayBracketPairsAfterParameterList, List<ReferenceType> throws_, BlockStmt body)

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.
List<ArrayBracketPair>	getArrayBracketPairsAfterElementType()
List<ArrayBracketPair>	getArrayBracketPairsAfterParameterList()
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] [static] [abstract] [final] [native] [synchronized] returnType methodName ([paramType [paramName]]) [throws exceptionsList]
Type	getElementType()
JavadocComment	getJavaDoc() Gets the JavaDoc for this node.
EnumSet<Modifier>	getModifiers() Return the modifiers of this member declaration.
String	getName()
NameExpr	getNameExpr()
List<Parameter>	getParameters()
List<ReferenceType>	getThrows()
Type	getType() Gets the type
List<TypeParameter>	getTypeParameters()
boolean	isDefault()
MethodDeclaration	setArrayBracketPairsAfterElementType(List<ArrayBracketPair> arrayBracketPairsAfterType)
MethodDeclaration	setArrayBracketPairsAfterParameterList(List<ArrayBracketPair> arrayBracketPairsAfterParameterList)
MethodDeclaration	setBody(BlockStmt body)
MethodDeclaration	setDefault(boolean isDefault)
MethodDeclaration	setElementType(Type elementType)
MethodDeclaration	setModifiers(EnumSet<Modifier> modifiers)
MethodDeclaration	setName(String name)
MethodDeclaration	setNameExpr(NameExpr name)
MethodDeclaration	setParameters(List<Parameter> parameters)
MethodDeclaration	setThrows(List<ReferenceType> throws_)
MethodDeclaration	setType(Type type) Sets the type
MethodDeclaration	setTypeParameters(List<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, contains, equals, getAllContainedComments, getBegin, getChildrenNodes, getComment, getEnd, getNodesByType, getOrphanComments, getParentNode, getParentNodeOfType, getRange, getUserData, hasComment, hashCode, isPositionedAfter, isPositionedBefore, setAsParentNodeOf, setAsParentNodeOf, setBegin, setBlockComment, setComment, setEnd, setLineComment, setParentNode, setRange, setUserData, toString, toStringWithoutComments, tryAddImportToParentCompilationUnit

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.NodeWithType

setType, setType

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

setElementType, setElementType

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

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

addThrows, addThrows, isThrows, isThrows

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

createBody

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

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

Constructor Detail

MethodDeclaration

public MethodDeclaration()

MethodDeclaration

public MethodDeclaration(EnumSet<Modifier> modifiers,
                         Type elementType,
                         String name)

MethodDeclaration

public MethodDeclaration(EnumSet<Modifier> modifiers,
                         Type elementType,
                         String name,
                         List<Parameter> parameters)

MethodDeclaration

public MethodDeclaration(EnumSet<Modifier> modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type elementType,
                         List<ArrayBracketPair> arrayBracketPairsAfterElementType,
                         String name,
                         List<Parameter> parameters,
                         List<ArrayBracketPair> arrayBracketPairsAfterParameterList,
                         List<ReferenceType> throws_,
                         BlockStmt body)

MethodDeclaration

public MethodDeclaration(Range range,
                         EnumSet<Modifier> modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type elementType,
                         List<ArrayBracketPair> arrayBracketPairsAfterElementType,
                         NameExpr nameExpr,
                         List<Parameter> parameters,
                         List<ArrayBracketPair> arrayBracketPairsAfterParameterList,
                         List<ReferenceType> throws_,
                         BlockStmt body)

Method Detail

accept

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

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

R - the type the return value of the visitor

A - the type the argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor

Returns:

the result of the visit

accept

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

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor

getBody

public BlockStmt getBody()

Specified by:

getBody in interface NodeWithBlockStmt<MethodDeclaration>

getModifiers

public EnumSet<Modifier> getModifiers()

Return the modifiers of this member declaration.

Specified by:

getModifiers in interface NodeWithModifiers<MethodDeclaration>

Returns:

modifiers

See Also:

Modifier

getName

public String getName()

Specified by:

getName in interface NodeWithName<MethodDeclaration>

getNameExpr

public NameExpr getNameExpr()

getParameters

public List<Parameter> getParameters()

Specified by:

getParameters in interface NodeWithParameters<MethodDeclaration>

getThrows

public List<ReferenceType> getThrows()

Specified by:

getThrows in interface NodeWithThrowable<MethodDeclaration>

getType

public Type getType()

Description copied from interface: NodeWithType

Gets the type

Specified by:

getType in interface NodeWithType<MethodDeclaration>

Returns:

the type

getElementType

public Type getElementType()

Specified by:

getElementType in interface NodeWithElementType<MethodDeclaration>

Returns:

the element type

getTypeParameters

public List<TypeParameter> getTypeParameters()

setBody

public MethodDeclaration setBody(BlockStmt body)

Specified by:

setBody in interface NodeWithBlockStmt<MethodDeclaration>

setModifiers

public MethodDeclaration setModifiers(EnumSet<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<MethodDeclaration>

setName

public MethodDeclaration setName(String name)

Specified by:

setName in interface NodeWithName<MethodDeclaration>

setNameExpr

public MethodDeclaration setNameExpr(NameExpr name)

setParameters

public MethodDeclaration setParameters(List<Parameter> parameters)

Specified by:

setParameters in interface NodeWithParameters<MethodDeclaration>

setThrows

public MethodDeclaration setThrows(List<ReferenceType> throws_)

Specified by:

setThrows in interface NodeWithThrowable<MethodDeclaration>

setType

public MethodDeclaration setType(Type type)

Description copied from interface: NodeWithType

Sets the type

Specified by:

setType in interface NodeWithType<MethodDeclaration>

Parameters:

type - the type

Returns:

this

setElementType

public MethodDeclaration setElementType(Type elementType)

Specified by:

setElementType in interface NodeWithElementType<MethodDeclaration>

Parameters:

elementType - the element elementType

Returns:

this

setTypeParameters

public MethodDeclaration setTypeParameters(List<TypeParameter> typeParameters)

isDefault

public boolean isDefault()

setDefault

public MethodDeclaration setDefault(boolean isDefault)

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

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(boolean includingModifiers,
                                     boolean includingThrows,
                                     boolean includingParameterName)

The declaration returned has this schema: [accessSpecifier] [static] [abstract] [final] [native] [synchronized] returnType methodName ([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:

method declaration as String

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<MethodDeclaration>

Returns:

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

getArrayBracketPairsAfterElementType

public List<ArrayBracketPair> getArrayBracketPairsAfterElementType()

Specified by:

getArrayBracketPairsAfterElementType in interface NodeWithElementType<MethodDeclaration>

Returns:

the array brackets in this position: class C { int[] abc; }

setArrayBracketPairsAfterElementType

public MethodDeclaration setArrayBracketPairsAfterElementType(List<ArrayBracketPair> arrayBracketPairsAfterType)

Specified by:

setArrayBracketPairsAfterElementType in interface NodeWithElementType<MethodDeclaration>

getArrayBracketPairsAfterParameterList

public List<ArrayBracketPair> getArrayBracketPairsAfterParameterList()

Returns:

the array brackets in this position: int abc()[] {...}

setArrayBracketPairsAfterParameterList

public MethodDeclaration setArrayBracketPairsAfterParameterList(List<ArrayBracketPair> arrayBracketPairsAfterParameterList)