com.github.javaparser.ast.body

Class MethodDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.body.BodyDeclaration

com.github.javaparser.ast.body.MethodDeclaration

All Implemented Interfaces:

AnnotableNode, WithDeclaration, DocumentableNode, NamedNode, NodeWithModifiers, TypedNode, Cloneable

public final class MethodDeclaration
extends BodyDeclaration
implements DocumentableNode, WithDeclaration, NamedNode, TypedNode, NodeWithModifiers

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(int beginLine, int beginColumn, int endLine, int endColumn, int modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type type, String name, List<Parameter> parameters, int arrayCount, List<ReferenceType> throws_, BlockStmt body) Deprecated. prefer using Range objects.
MethodDeclaration(int modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type type, String name, List<Parameter> parameters, int arrayCount, List<ReferenceType> throws_, BlockStmt body)
MethodDeclaration(int modifiers, Type type, String name)
MethodDeclaration(int modifiers, Type type, String name, List<Parameter> parameters)
MethodDeclaration(Range range, int modifiers, List<AnnotationExpr> annotations, List<TypeParameter> typeParameters, Type type, String name, List<Parameter> parameters, int arrayCount, 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.
int	getArrayCount()
BlockStmt	getBody()
String	getDeclarationAsString() As WithDeclaration.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 WithDeclaration.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]
JavadocComment	getJavaDoc() Gets the JavaDoc for this node.
int	getModifiers() Return the modifiers of this member declaration.
String	getName()
NameExpr	getNameExpr()
List<Parameter>	getParameters()
List<ReferenceType>	getThrows()
Type	getType()
List<TypeParameter>	getTypeParameters()
boolean	isDefault()
void	setArrayCount(int arrayCount)
void	setBody(BlockStmt body)
void	setDefault(boolean isDefault)
void	setModifiers(int modifiers)
void	setName(String name)
void	setNameExpr(NameExpr name)
void	setParameters(List<Parameter> parameters)
void	setThrows(List<ReferenceType> throws_)
void	setType(Type type)
void	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, getBeginColumn, getBeginLine, getChildrenNodes, getComment, getData, getEnd, getEndColumn, getEndLine, getOrphanComments, getParentNode, getRange, hasComment, hashCode, isPositionedAfter, isPositionedAfter, isPositionedBefore, isPositionedBefore, setAsParentNodeOf, setAsParentNodeOf, setBegin, setBeginColumn, setBeginLine, setComment, setData, setEnd, setEndColumn, setEndLine, setParentNode, setRange, toString, toStringWithoutComments

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodDeclaration

public MethodDeclaration()

MethodDeclaration

public MethodDeclaration(int modifiers,
                         Type type,
                         String name)

MethodDeclaration

public MethodDeclaration(int modifiers,
                         Type type,
                         String name,
                         List<Parameter> parameters)

MethodDeclaration

public MethodDeclaration(int modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type type,
                         String name,
                         List<Parameter> parameters,
                         int arrayCount,
                         List<ReferenceType> throws_,
                         BlockStmt body)

MethodDeclaration

@Deprecated
public MethodDeclaration(int beginLine,
                                     int beginColumn,
                                     int endLine,
                                     int endColumn,
                                     int modifiers,
                                     List<AnnotationExpr> annotations,
                                     List<TypeParameter> typeParameters,
                                     Type type,
                                     String name,
                                     List<Parameter> parameters,
                                     int arrayCount,
                                     List<ReferenceType> throws_,
                                     BlockStmt body)

Deprecated. prefer using Range objects.

MethodDeclaration

public MethodDeclaration(Range range,
                         int modifiers,
                         List<AnnotationExpr> annotations,
                         List<TypeParameter> typeParameters,
                         Type type,
                         String name,
                         List<Parameter> parameters,
                         int arrayCount,
                         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

getArrayCount

public int getArrayCount()

getBody

public BlockStmt getBody()

getModifiers

public int getModifiers()

Return the modifiers of this member declaration.

Specified by:

getModifiers in interface NodeWithModifiers

Returns:

modifiers

See Also:

ModifierSet

getName

public String getName()

Specified by:

getName in interface NamedNode

getNameExpr

public NameExpr getNameExpr()

getParameters

public List<Parameter> getParameters()

getThrows

public List<ReferenceType> getThrows()

getType

public Type getType()

Specified by:

getType in interface TypedNode

getTypeParameters

public List<TypeParameter> getTypeParameters()

setArrayCount

public void setArrayCount(int arrayCount)

setBody

public void setBody(BlockStmt body)

setModifiers

public void setModifiers(int modifiers)

setName

public void setName(String name)

setNameExpr

public void setNameExpr(NameExpr name)

setParameters

public void setParameters(List<Parameter> parameters)

setThrows

public void setThrows(List<ReferenceType> throws_)

setType

public void setType(Type type)

Specified by:

setType in interface TypedNode

setTypeParameters

public void setTypeParameters(List<TypeParameter> typeParameters)

isDefault

public boolean isDefault()

setDefault

public void setDefault(boolean isDefault)

getDeclarationAsString

public String getDeclarationAsString()

Description copied from interface: WithDeclaration

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

Specified by:

getDeclarationAsString in interface WithDeclaration

Returns:

String representation of declaration

getDeclarationAsString

public String getDeclarationAsString(boolean includingModifiers,
                                     boolean includingThrows)

Description copied from interface: WithDeclaration

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

Specified by:

getDeclarationAsString in interface WithDeclaration

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 WithDeclaration

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: DocumentableNode

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

Specified by:

getJavaDoc in interface DocumentableNode

Returns:

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