Package com.github.javaparser.ast.body
Class MethodDeclaration
- java.lang.Object
-
- com.github.javaparser.ast.Node
-
- com.github.javaparser.ast.body.BodyDeclaration<T>
-
- com.github.javaparser.ast.body.CallableDeclaration<MethodDeclaration>
-
- com.github.javaparser.ast.body.MethodDeclaration
-
- All Implemented Interfaces:
NodeWithAbstractModifier<MethodDeclaration>
,NodeWithAccessModifiers<MethodDeclaration>
,NodeWithFinalModifier<MethodDeclaration>
,NodeWithPrivateModifier<MethodDeclaration>
,NodeWithProtectedModifier<MethodDeclaration>
,NodeWithPublicModifier<MethodDeclaration>
,NodeWithStaticModifier<MethodDeclaration>
,NodeWithStrictfpModifier<MethodDeclaration>
,NodeWithAnnotations<MethodDeclaration>
,NodeWithDeclaration
,NodeWithJavadoc<MethodDeclaration>
,NodeWithModifiers<MethodDeclaration>
,NodeWithOptionalBlockStmt<MethodDeclaration>
,NodeWithParameters<MethodDeclaration>
,NodeWithRange<Node>
,NodeWithSimpleName<MethodDeclaration>
,NodeWithThrownExceptions<MethodDeclaration>
,NodeWithTokenRange<Node>
,NodeWithType<MethodDeclaration,Type>
,NodeWithTypeParameters<MethodDeclaration>
,Observable
,Visitable
,HasParentNode<Node>
,Cloneable
public final class MethodDeclaration extends CallableDeclaration<MethodDeclaration> implements NodeWithType<MethodDeclaration,Type>, NodeWithOptionalBlockStmt<MethodDeclaration>, NodeWithJavadoc<MethodDeclaration>, NodeWithDeclaration, NodeWithSimpleName<MethodDeclaration>, NodeWithParameters<MethodDeclaration>, NodeWithThrownExceptions<MethodDeclaration>, NodeWithTypeParameters<MethodDeclaration>, NodeWithAccessModifiers<MethodDeclaration>, NodeWithAbstractModifier<MethodDeclaration>, NodeWithStaticModifier<MethodDeclaration>, NodeWithFinalModifier<MethodDeclaration>, NodeWithStrictfpModifier<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.body.CallableDeclaration
CallableDeclaration.Signature
-
Nested classes/interfaces inherited from class com.github.javaparser.ast.Node
Node.ObserverRegistrationMode, Node.Parsedness
-
-
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 Description MethodDeclaration()
MethodDeclaration(TokenRange tokenRange, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, Type type, SimpleName name, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, BlockStmt body)
This constructor is used by the parser and is considered private.MethodDeclaration(EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, Type type, SimpleName name, boolean isDefault, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, BlockStmt body)
Deprecated.this constructor allows you to set "isDefault", but this is no longer a field of this node, but simply one of the modifiers.MethodDeclaration(EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, Type type, SimpleName name, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, BlockStmt body)
MethodDeclaration(EnumSet<Modifier> modifiers, Type type, String name)
MethodDeclaration(EnumSet<Modifier> modifiers, String name, Type type, NodeList<Parameter> parameters)
-
Method Summary
-
Methods inherited from class com.github.javaparser.ast.body.CallableDeclaration
appendThrowsIfRequested, getDeclarationAsString, getDeclarationAsString, getModifiers, getName, getParameters, getSignature, getThrownExceptions, getTypeParameters
-
Methods inherited from class com.github.javaparser.ast.body.BodyDeclaration
getAnnotations, setAnnotations
-
Methods inherited from class com.github.javaparser.ast.Node
addOrphanComment, customInitialization, equals, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getTokenRange, hasComment, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, 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.HasParentNode
getAncestorOfType
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithAbstractModifier
isAbstract, setAbstract
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithAnnotations
addAndGetAnnotation, addAndGetAnnotation, addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent, setAnnotation, tryAddImportToParentCompilationUnit
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithDeclaration
getDeclarationAsString, getDeclarationAsString
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithFinalModifier
isFinal, setFinal
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithJavadoc
getComment, getJavadoc, getJavadocComment, hasJavaDocComment, removeJavaDocComment, setComment, setJavadocComment, setJavadocComment, setJavadocComment
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithModifiers
addModifier, getModifiers, removeModifier, setModifier
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithOptionalBlockStmt
createBody
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithParameters
addAndGetParameter, addAndGetParameter, addAndGetParameter, addAndGetParameter, addParameter, addParameter, addParameter, addParameter, getParameter, getParameterByName, getParameterByType, getParameterByType, getParameters, hasParametersOfType, hasParametersOfType, setParameter, tryAddImportToParentCompilationUnit
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPrivateModifier
isPrivate, setPrivate
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithProtectedModifier
isProtected, setProtected
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPublicModifier
isPublic, setPublic
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange
containsWithin, getBegin, getEnd, isPositionedAfter, isPositionedBefore
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithSimpleName
getName, getNameAsString, setName
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithStaticModifier
isStatic, setStatic
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithStrictfpModifier
isStrictfp, setStrictfp
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithThrownExceptions
addThrownException, addThrownException, getThrownException, getThrownExceptions, isThrown, isThrown, tryAddImportToParentCompilationUnit
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithType
setType, setType, tryAddImportToParentCompilationUnit
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithTypeParameters
addTypeParameter, getTypeParameter, getTypeParameters, isGeneric, setTypeParameter
-
-
-
-
Constructor Detail
-
MethodDeclaration
public MethodDeclaration()
-
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, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, BlockStmt body)
-
MethodDeclaration
@Deprecated 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)
Deprecated.this constructor allows you to set "isDefault", but this is no longer a field of this node, but simply one of the modifiers. Use setDefault(boolean) or add DEFAULT to the modifiers set.
-
MethodDeclaration
@Generated("com.github.javaparser.generator.core.node.MainConstructorGenerator") public MethodDeclaration(TokenRange tokenRange, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, Type type, SimpleName name, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, BlockStmt body)
This constructor is used by the parser and is considered private.
-
-
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 interfaceVisitable
- Type Parameters:
R
- the type of the return value of the visitorA
- the type the user argument passed to the visitor- Parameters:
v
- the visitor implementationarg
- 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.
-
getBody
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator") public Optional<BlockStmt> getBody()
- Specified by:
getBody
in interfaceNodeWithOptionalBlockStmt<MethodDeclaration>
-
setBody
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator") public MethodDeclaration setBody(BlockStmt body)
Sets the body- Specified by:
setBody
in interfaceNodeWithOptionalBlockStmt<MethodDeclaration>
- Parameters:
body
- the body, can be null- Returns:
- this, the MethodDeclaration
-
getType
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator") public Type getType()
Description copied from interface:NodeWithType
Gets the type- Specified by:
getType
in interfaceNodeWithType<MethodDeclaration,Type>
- Returns:
- the type
-
setType
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator") public MethodDeclaration setType(Type type)
Description copied from interface:NodeWithType
Sets the type- Specified by:
setType
in interfaceNodeWithType<MethodDeclaration,Type>
- Parameters:
type
- the type- Returns:
- this
-
setModifiers
public MethodDeclaration setModifiers(EnumSet<Modifier> modifiers)
- Specified by:
setModifiers
in interfaceNodeWithModifiers<MethodDeclaration>
- Overrides:
setModifiers
in classCallableDeclaration<MethodDeclaration>
-
setName
public MethodDeclaration setName(SimpleName name)
- Specified by:
setName
in interfaceNodeWithSimpleName<MethodDeclaration>
- Overrides:
setName
in classCallableDeclaration<MethodDeclaration>
-
setParameters
public MethodDeclaration setParameters(NodeList<Parameter> parameters)
- Specified by:
setParameters
in interfaceNodeWithParameters<MethodDeclaration>
- Overrides:
setParameters
in classCallableDeclaration<MethodDeclaration>
-
setThrownExceptions
public MethodDeclaration setThrownExceptions(NodeList<ReferenceType> thrownExceptions)
- Specified by:
setThrownExceptions
in interfaceNodeWithThrownExceptions<MethodDeclaration>
- Overrides:
setThrownExceptions
in classCallableDeclaration<MethodDeclaration>
-
setTypeParameters
public MethodDeclaration setTypeParameters(NodeList<TypeParameter> typeParameters)
- Specified by:
setTypeParameters
in interfaceNodeWithTypeParameters<MethodDeclaration>
- Overrides:
setTypeParameters
in classCallableDeclaration<MethodDeclaration>
-
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 interfaceNodeWithDeclaration
- Specified by:
getDeclarationAsString
in classCallableDeclaration<MethodDeclaration>
- Parameters:
includingModifiers
- flag to include the modifiers (if present) in the string producedincludingThrows
- flag to include the throws clause (if present) in the string producedincludingParameterName
- flag to include the parameter name (while the parameter type is always included) in the string produced- Returns:
- method declaration as String
-
isNative
public boolean isNative()
-
isSynchronized
public boolean isSynchronized()
-
isDefault
public boolean isDefault()
-
setNative
public MethodDeclaration setNative(boolean set)
-
setSynchronized
public MethodDeclaration setSynchronized(boolean set)
-
setDefault
public MethodDeclaration setDefault(boolean set)
-
getNodeLists
@Generated("com.github.javaparser.generator.core.node.GetNodeListsGenerator") public List<NodeList<?>> getNodeLists()
Description copied from class:Node
The list of NodeLists owned by this node.- Overrides:
getNodeLists
in classCallableDeclaration<MethodDeclaration>
-
remove
@Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator") public boolean remove(Node node)
- Overrides:
remove
in classCallableDeclaration<MethodDeclaration>
-
removeBody
@Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator") public MethodDeclaration removeBody()
- Specified by:
removeBody
in interfaceNodeWithOptionalBlockStmt<MethodDeclaration>
-
clone
@Generated("com.github.javaparser.generator.core.node.CloneGenerator") public MethodDeclaration clone()
- Overrides:
clone
in classCallableDeclaration<MethodDeclaration>
-
getMetaModel
@Generated("com.github.javaparser.generator.core.node.GetMetaModelGenerator") public MethodDeclarationMetaModel getMetaModel()
- Overrides:
getMetaModel
in classCallableDeclaration<MethodDeclaration>
- Returns:
- get JavaParser specific node introspection information.
-
replace
@Generated("com.github.javaparser.generator.core.node.ReplaceMethodGenerator") public boolean replace(Node node, Node replacementNode)
- Overrides:
replace
in classCallableDeclaration<MethodDeclaration>
-
-