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>, NodeWithDeclaration, NodeWithJavadoc<MethodDeclaration>, NodeWithModifiers<MethodDeclaration>, NodeWithOptionalBlockStmt<MethodDeclaration>, NodeWithParameters<MethodDeclaration>, NodeWithSimpleName<MethodDeclaration>, NodeWithThrownExceptions<MethodDeclaration>, NodeWithType<MethodDeclaration,Type>, NodeWithTypeParameters<MethodDeclaration>, Observable, Visitable, HasParentNode<Node>, Cloneable

public final class MethodDeclaration
extends BodyDeclaration<MethodDeclaration>
implements NodeWithJavadoc<MethodDeclaration>, NodeWithDeclaration, NodeWithSimpleName<MethodDeclaration>, NodeWithType<MethodDeclaration,Type>, NodeWithModifiers<MethodDeclaration>, NodeWithParameters<MethodDeclaration>, NodeWithThrownExceptions<MethodDeclaration>, NodeWithOptionalBlockStmt<MethodDeclaration>, NodeWithTypeParameters<MethodDeclaration>

A method declaration. "public int abc() {return 1;}" in this example: class X { public int abc() {return 1;} }

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
MethodDeclaration()
MethodDeclaration(EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, Type type, SimpleName name, boolean isDefault, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, BlockStmt body)
MethodDeclaration(EnumSet<Modifier> modifiers, String name, Type type, NodeList<Parameter> parameters)
MethodDeclaration(EnumSet<Modifier> modifiers, Type type, String name)
MethodDeclaration(Range range, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, Type type, SimpleName name, boolean isDefault, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, 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.
Optional<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:
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()
Type	getType() Gets the type
NodeList<TypeParameter>	getTypeParameters()
boolean	isDefault()
MethodDeclaration	setBody(BlockStmt body) Sets the body
MethodDeclaration	setDefault(boolean isDefault)
MethodDeclaration	setModifiers(EnumSet<Modifier> modifiers)
MethodDeclaration	setName(SimpleName name)
MethodDeclaration	setParameters(NodeList<Parameter> parameters)
MethodDeclaration	setThrownExceptions(NodeList<ReferenceType> thrownExceptions)
MethodDeclaration	setType(Type type) Sets the type
MethodDeclaration	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, hasJavaDocComment, isPositionedAfter, isPositionedBefore, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeOrphanComment, 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

removeJavaDocComment, setJavaDocComment

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

getNameAsString, setName

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

setType, setType

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, getParameter, getParameterByName, getParameterByType, getParameterByType, setParameter

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

addThrownException, addThrownException, getThrownException, isThrown, isThrown

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

createBody

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

addTypeParameter, getTypeParameter, isGeneric, setTypeParameter

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

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

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Constructor Detail

MethodDeclaration

public MethodDeclaration()

MethodDeclaration

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

MethodDeclaration

public MethodDeclaration(EnumSet<Modifier> modifiers,
                         String name,
                         Type type,
                         NodeList<Parameter> parameters)

MethodDeclaration

public MethodDeclaration(EnumSet<Modifier> modifiers,
                         NodeList<AnnotationExpr> annotations,
                         NodeList<TypeParameter> typeParameters,
                         Type type,
                         SimpleName name,
                         boolean isDefault,
                         NodeList<Parameter> parameters,
                         NodeList<ReferenceType> thrownExceptions,
                         BlockStmt body)

MethodDeclaration

public MethodDeclaration(Range range,
                         EnumSet<Modifier> modifiers,
                         NodeList<AnnotationExpr> annotations,
                         NodeList<TypeParameter> typeParameters,
                         Type type,
                         SimpleName name,
                         boolean isDefault,
                         NodeList<Parameter> parameters,
                         NodeList<ReferenceType> thrownExceptions,
                         BlockStmt body)

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)

getBody

public Optional<BlockStmt> getBody()

Specified by:

getBody in interface NodeWithOptionalBlockStmt<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 SimpleName getName()

Specified by:

getName in interface NodeWithSimpleName<MethodDeclaration>

getParameters

public NodeList<Parameter> getParameters()

Specified by:

getParameters in interface NodeWithParameters<MethodDeclaration>

getThrownExceptions

public NodeList<ReferenceType> getThrownExceptions()

Specified by:

getThrownExceptions in interface NodeWithThrownExceptions<MethodDeclaration>

getTypeParameters

public NodeList<TypeParameter> getTypeParameters()

Specified by:

getTypeParameters in interface NodeWithTypeParameters<MethodDeclaration>

setBody

public MethodDeclaration setBody(BlockStmt body)

Sets the body

Specified by:

setBody in interface NodeWithOptionalBlockStmt<MethodDeclaration>

Parameters:

body - the body, can be null

Returns:

this, the MethodDeclaration

setModifiers

public MethodDeclaration setModifiers(EnumSet<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<MethodDeclaration>

setName

public MethodDeclaration setName(SimpleName name)

Specified by:

setName in interface NodeWithSimpleName<MethodDeclaration>

setParameters

public MethodDeclaration setParameters(NodeList<Parameter> parameters)

Specified by:

setParameters in interface NodeWithParameters<MethodDeclaration>

setThrownExceptions

public MethodDeclaration setThrownExceptions(NodeList<ReferenceType> thrownExceptions)

Specified by:

setThrownExceptions in interface NodeWithThrownExceptions<MethodDeclaration>

getType

public Type getType()

Description copied from interface: NodeWithType

Gets the type

Specified by:

getType in interface NodeWithType<MethodDeclaration,Type>

Returns:

the type

setType

public MethodDeclaration setType(Type type)

Description copied from interface: NodeWithType

Sets the type

Specified by:

setType in interface NodeWithType<MethodDeclaration,Type>

Parameters:

type - the type

Returns:

this

setTypeParameters

public MethodDeclaration setTypeParameters(NodeList<TypeParameter> typeParameters)

Specified by:

setTypeParameters in interface NodeWithTypeParameters<MethodDeclaration>

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.

getNodeLists

public List<NodeList<?>> getNodeLists()

Description copied from class: Node

The list of NodeLists owned by this node.

Overrides:

getNodeLists in class BodyDeclaration<MethodDeclaration>