Class CallableDeclaration<T extends CallableDeclaration<?>>

java.lang.Object

com.github.javaparser.ast.Node

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

com.github.javaparser.ast.body.CallableDeclaration<T>

All Implemented Interfaces:

NodeWithAbstractModifier<T>, NodeWithAccessModifiers<T>, NodeWithFinalModifier<T>, NodeWithPrivateModifier<T>, NodeWithProtectedModifier<T>, NodeWithPublicModifier<T>, NodeWithStaticModifier<T>, NodeWithStrictfpModifier<T>, NodeWithAnnotations<T>, NodeWithDeclaration, NodeWithJavadoc<T>, NodeWithModifiers<T>, NodeWithParameters<T>, NodeWithRange<Node>, NodeWithSimpleName<T>, NodeWithThrownExceptions<T>, NodeWithTokenRange<Node>, NodeWithTypeParameters<T>, Observable, Visitable, HasParentNode<Node>, Cloneable

Direct Known Subclasses:

ConstructorDeclaration, MethodDeclaration

public abstract class CallableDeclaration<T extends CallableDeclaration<?>>
extends BodyDeclaration<T>
implements NodeWithAccessModifiers<T>, NodeWithDeclaration, NodeWithSimpleName<T>, NodeWithParameters<T>, NodeWithThrownExceptions<T>, NodeWithTypeParameters<T>, NodeWithJavadoc<T>, NodeWithAbstractModifier<T>, NodeWithStaticModifier<T>, NodeWithFinalModifier<T>, NodeWithStrictfpModifier<T>

Represents a declaration which is callable eg. a method or a constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CallableDeclaration.Signature	A method or constructor signature.

Nested classes/interfaces inherited from class Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields

Modifier and Type	Field	Description
private NodeList<Modifier>	modifiers
private SimpleName	name
private NodeList<Parameter>	parameters
private ReceiverParameter	receiverParameter
private NodeList<ReferenceType>	thrownExceptions
private NodeList<TypeParameter>	typeParameters

Fields inherited from class Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
CallableDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, SimpleName name, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, ReceiverParameter receiverParameter)
CallableDeclaration(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<TypeParameter> typeParameters, SimpleName name, NodeList<Parameter> parameters, NodeList<ReferenceType> thrownExceptions, ReceiverParameter receiverParameter)	This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method	Description
protected String	appendThrowsIfRequested(boolean includingThrows)
CallableDeclaration	asCallableDeclaration()
CallableDeclaration<?>	clone()
CallableDeclarationMetaModel	getMetaModel()
NodeList<Modifier>	getModifiers()	Return the modifiers of this member declaration.
SimpleName	getName()
NodeList<Parameter>	getParameters()
Optional<ReceiverParameter>	getReceiverParameter()
CallableDeclaration.Signature	getSignature()
NodeList<ReferenceType>	getThrownExceptions()
NodeList<TypeParameter>	getTypeParameters()
private Type	getTypeWithVarargsAsArray(Parameter p)
void	ifCallableDeclaration(Consumer<CallableDeclaration> action)
boolean	isCallableDeclaration()
boolean	isFixedArityMethod()
boolean	isVariableArityMethod()
boolean	remove(Node node)
CallableDeclaration	removeReceiverParameter()
boolean	replace(Node node, Node replacementNode)
T	setModifiers(NodeList<Modifier> modifiers)
T	setName(SimpleName name)
T	setParameters(NodeList<Parameter> parameters)
T	setReceiverParameter(ReceiverParameter receiverParameter)
T	setThrownExceptions(NodeList<ReferenceType> thrownExceptions)
T	setTypeParameters(NodeList<TypeParameter> typeParameters)
private Type	stripAnnotations(Type type)
private Type	stripGenerics(Type type)
Optional<CallableDeclaration>	toCallableDeclaration()

Methods inherited from class BodyDeclaration

asAnnotationDeclaration, asAnnotationMemberDeclaration, asClassOrInterfaceDeclaration, asCompactConstructorDeclaration, asConstructorDeclaration, asEnumConstantDeclaration, asEnumDeclaration, asFieldDeclaration, asInitializerDeclaration, asMethodDeclaration, asRecordDeclaration, asTypeDeclaration, getAnnotations, ifAnnotationDeclaration, ifAnnotationMemberDeclaration, ifClassOrInterfaceDeclaration, ifCompactConstructorDeclaration, ifConstructorDeclaration, ifEnumConstantDeclaration, ifEnumDeclaration, ifFieldDeclaration, ifInitializerDeclaration, ifMethodDeclaration, ifRecordDeclaration, ifTypeDeclaration, isAnnotationDeclaration, isAnnotationMemberDeclaration, isClassOrInterfaceDeclaration, isCompactConstructorDeclaration, isConstructorDeclaration, isEnumConstantDeclaration, isEnumDeclaration, isFieldDeclaration, isInitializerDeclaration, isMethodDeclaration, isRecordDeclaration, isTypeDeclaration, setAnnotations, toAnnotationDeclaration, toAnnotationMemberDeclaration, toClassOrInterfaceDeclaration, toCompactConstructorDeclaration, toConstructorDeclaration, toEnumConstantDeclaration, toEnumDeclaration, toFieldDeclaration, toInitializerDeclaration, toMethodDeclaration, toRecordDeclaration, toTypeDeclaration

Methods inherited from class Node

addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findByRange, findCompilationUnit, findData, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getDefaultPrinterConfiguration, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getPrinter, getPrinter, getRange, getSymbolResolver, getTokenRange, hashCode, hasScope, isAncestorOf, isPhantom, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class Object

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

Methods inherited from interface HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface NodeWithAbstractModifier

isAbstract, setAbstract

Methods inherited from interface NodeWithAnnotations

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

Methods inherited from interface NodeWithDeclaration

getDeclarationAsString, getDeclarationAsString, getDeclarationAsString

Methods inherited from interface NodeWithFinalModifier

isFinal, setFinal

Methods inherited from interface NodeWithJavadoc

getComment, getJavadoc, getJavadocComment, hasJavaDocComment, removeJavaDocComment, setComment, setJavadocComment, setJavadocComment, setJavadocComment, setJavadocComment, setJavadocComment

Methods inherited from interface NodeWithModifiers

addModifier, getAccessSpecifier, hasModifier, removeModifier, setModifier, setModifiers

Methods inherited from interface NodeWithParameters

addAndGetParameter, addAndGetParameter, addAndGetParameter, addAndGetParameter, addParameter, addParameter, addParameter, addParameter, getParameter, getParameterByName, getParameterByType, getParameterByType, hasParametersOfType, hasParametersOfType, setParameter, tryAddImportToParentCompilationUnit

Methods inherited from interface NodeWithPrivateModifier

isPrivate, setPrivate

Methods inherited from interface NodeWithProtectedModifier

isProtected, setProtected

Methods inherited from interface NodeWithPublicModifier

isPublic, setPublic

Methods inherited from interface NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Methods inherited from interface NodeWithSimpleName

getNameAsExpression, getNameAsString, setName

Methods inherited from interface NodeWithStaticModifier

isStatic, setStatic

Methods inherited from interface NodeWithStrictfpModifier

isStrictfp, setStrictfp

Methods inherited from interface NodeWithThrownExceptions

addThrownException, addThrownException, getThrownException, isThrown, isThrown, tryAddImportToParentCompilationUnit

Methods inherited from interface NodeWithTypeParameters

addTypeParameter, addTypeParameter, getTypeParameter, isGeneric, setTypeParameter

Methods inherited from interface Visitable

accept, accept

Field Details

modifiers

private NodeList<Modifier> modifiers

typeParameters

private NodeList<TypeParameter> typeParameters

name

private SimpleName name

parameters

private NodeList<Parameter> parameters

thrownExceptions

private NodeList<ReferenceType> thrownExceptions

receiverParameter

private ReceiverParameter receiverParameter

Constructor Details

CallableDeclaration

CallableDeclaration(NodeList<Modifier> modifiers,
 NodeList<AnnotationExpr> annotations,
 NodeList<TypeParameter> typeParameters,
 SimpleName name,
 NodeList<Parameter> parameters,
 NodeList<ReferenceType> thrownExceptions,
 ReceiverParameter receiverParameter)

CallableDeclaration

public CallableDeclaration(TokenRange tokenRange,
 NodeList<Modifier> modifiers,
 NodeList<AnnotationExpr> annotations,
 NodeList<TypeParameter> typeParameters,
 SimpleName name,
 NodeList<Parameter> parameters,
 NodeList<ReferenceType> thrownExceptions,
 ReceiverParameter receiverParameter)

This constructor is used by the parser and is considered private.

Method Details

getModifiers

public NodeList<Modifier> getModifiers()

Return the modifiers of this member declaration.

Specified by:

getModifiers in interface NodeWithModifiers<T extends CallableDeclaration<?>>

Returns:

modifiers

See Also:

• Modifier

setModifiers

public T setModifiers(NodeList<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<T extends CallableDeclaration<?>>

getName

public SimpleName getName()

Specified by:

getName in interface NodeWithSimpleName<T extends CallableDeclaration<?>>

setName

public T setName(SimpleName name)

Specified by:

setName in interface NodeWithSimpleName<T extends CallableDeclaration<?>>

getParameters

public NodeList<Parameter> getParameters()

Specified by:

getParameters in interface NodeWithParameters<T extends CallableDeclaration<?>>

setParameters

public T setParameters(NodeList<Parameter> parameters)

Specified by:

setParameters in interface NodeWithParameters<T extends CallableDeclaration<?>>

getThrownExceptions

public NodeList<ReferenceType> getThrownExceptions()

Specified by:

getThrownExceptions in interface NodeWithThrownExceptions<T extends CallableDeclaration<?>>

setThrownExceptions

public T setThrownExceptions(NodeList<ReferenceType> thrownExceptions)

Specified by:

setThrownExceptions in interface NodeWithThrownExceptions<T extends CallableDeclaration<?>>

getTypeParameters

public NodeList<TypeParameter> getTypeParameters()

Specified by:

getTypeParameters in interface NodeWithTypeParameters<T extends CallableDeclaration<?>>

setTypeParameters

public T setTypeParameters(NodeList<TypeParameter> typeParameters)

Specified by:

setTypeParameters in interface NodeWithTypeParameters<T extends CallableDeclaration<?>>

appendThrowsIfRequested

protected String appendThrowsIfRequested(boolean includingThrows)

remove

public boolean remove(Node node)

Overrides:

remove in class BodyDeclaration<T extends CallableDeclaration<?>>

getSignature

public CallableDeclaration.Signature getSignature()

stripAnnotations

private Type stripAnnotations(Type type)

stripGenerics

private Type stripGenerics(Type type)

getTypeWithVarargsAsArray

private Type getTypeWithVarargsAsArray(Parameter p)

clone

public CallableDeclaration<?> clone()

Overrides:

clone in class BodyDeclaration<T extends CallableDeclaration<?>>

getMetaModel

public CallableDeclarationMetaModel getMetaModel()

Overrides:

getMetaModel in class BodyDeclaration<T extends CallableDeclaration<?>>

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
 Node replacementNode)

Overrides:

replace in class BodyDeclaration<T extends CallableDeclaration<?>>

isCallableDeclaration

public boolean isCallableDeclaration()

Overrides:

isCallableDeclaration in class BodyDeclaration<T extends CallableDeclaration<?>>

asCallableDeclaration

public CallableDeclaration asCallableDeclaration()

Overrides:

asCallableDeclaration in class BodyDeclaration<T extends CallableDeclaration<?>>

ifCallableDeclaration

public void ifCallableDeclaration(Consumer<CallableDeclaration> action)

Overrides:

ifCallableDeclaration in class BodyDeclaration<T extends CallableDeclaration<?>>

getReceiverParameter

public Optional<ReceiverParameter> getReceiverParameter()

setReceiverParameter

public T setReceiverParameter(ReceiverParameter receiverParameter)

removeReceiverParameter

public CallableDeclaration removeReceiverParameter()

toCallableDeclaration

public Optional<CallableDeclaration> toCallableDeclaration()

Overrides:

toCallableDeclaration in class BodyDeclaration<T extends CallableDeclaration<?>>

isVariableArityMethod

public boolean isVariableArityMethod()

isFixedArityMethod

public boolean isFixedArityMethod()