Package com.github.javaparser.ast.body
Class Parameter
java.lang.Object
com.github.javaparser.ast.Node
com.github.javaparser.ast.body.Parameter
- All Implemented Interfaces:
NodeWithFinalModifier<Parameter>
,NodeWithAnnotations<Parameter>
,NodeWithModifiers<Parameter>
,NodeWithRange<Node>
,NodeWithSimpleName<Parameter>
,NodeWithTokenRange<Node>
,NodeWithType<Parameter,Type>
,Observable
,Visitable
,HasParentNode<Node>
,Resolvable<ResolvedParameterDeclaration>
,Cloneable
public class Parameter
extends Node
implements NodeWithType<Parameter,Type>, NodeWithAnnotations<Parameter>, NodeWithSimpleName<Parameter>, NodeWithFinalModifier<Parameter>, Resolvable<ResolvedParameterDeclaration>
The parameters to a method or lambda. Lambda parameters may have inferred types, in that case "type" is UnknownType.
Note that parameters are different from arguments.
"String x" and "float y" are the parameters in
All annotations preceding the type will be set on this object, not on the type. JavaParser doesn't know if it they are applicable to the parameter or the type.
Note that parameters are different from arguments.
"String x" and "float y" are the parameters in
int abc(String x, float
y) {...}
All annotations preceding the type will be set on this object, not on the type. JavaParser doesn't know if it they are applicable to the parameter or the type.
- Author:
- Julio Vilmar Gesser
-
Nested Class Summary
Nested classes/interfaces inherited from class com.github.javaparser.ast.Node
Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal
-
Field Summary
Fields inherited from class com.github.javaparser.ast.Node
ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY
-
Constructor Summary
ConstructorDescriptionParameter(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type type, boolean isVarArgs, NodeList<AnnotationExpr> varArgsAnnotations, SimpleName name)
Parameter(NodeList<Modifier> modifiers, Type type, SimpleName name)
Parameter(Type type, SimpleName name)
Creates a newParameter
.Parameter(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type type, boolean isVarArgs, NodeList<AnnotationExpr> varArgsAnnotations, SimpleName name)
This constructor is used by the parser and is considered private. -
Method Summary
Modifier and TypeMethodDescription<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.clone()
Return the modifiers of this parameter declaration.getName()
getType()
Gets the typeboolean
isFinal()
Record components (parameters here) are implicitly final, even without the explicitly-added modifier.boolean
boolean
boolean
resolve()
setAnnotations(NodeList<AnnotationExpr> annotations)
setModifiers(NodeList<Modifier> modifiers)
setName(SimpleName name)
Sets the typesetVarArgs(boolean isVarArgs)
setVarArgsAnnotations(NodeList<AnnotationExpr> varArgsAnnotations)
Methods inherited from class com.github.javaparser.ast.Node
addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findCompilationUnit, 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 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.github.javaparser.HasParentNode
findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithAnnotations
addAndGetAnnotation, addAndGetAnnotation, addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent, setAnnotation, tryAddImportToParentCompilationUnit
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithFinalModifier
setFinal
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithModifiers
addModifier, getAccessSpecifier, hasModifier, removeModifier, setModifier, setModifiers
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange
containsWithin, containsWithinRange, getBegin, getEnd, hasRange
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithSimpleName
getNameAsExpression, getNameAsString, setName
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithType
getTypeAsString, setType, setType, tryAddImportToParentCompilationUnit
-
Constructor Details
-
Parameter
public Parameter() -
Parameter
-
Parameter
Creates a newParameter
.- Parameters:
type
- type of the parametername
- name of the parameter
-
Parameter
-
Parameter
public Parameter(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type type, boolean isVarArgs, NodeList<AnnotationExpr> varArgsAnnotations, SimpleName name) -
Parameter
public Parameter(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type type, boolean isVarArgs, NodeList<AnnotationExpr> varArgsAnnotations, SimpleName name)This constructor is used by the parser and is considered private.
-
-
Method Details
-
accept
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
Description copied from interface:Visitable
Accept method for visitor support. -
getType
Description copied from interface:NodeWithType
Gets the type- Specified by:
getType
in interfaceNodeWithType<Parameter,Type>
- Returns:
- the type
-
isVarArgs
public boolean isVarArgs() -
setType
Description copied from interface:NodeWithType
Sets the type- Specified by:
setType
in interfaceNodeWithType<Parameter,Type>
- Parameters:
type
- the type- Returns:
- this
-
setVarArgs
-
getAnnotations
- Specified by:
getAnnotations
in interfaceNodeWithAnnotations<Parameter>
- Returns:
- the list returned could be immutable (in that case it will be empty)
-
getName
- Specified by:
getName
in interfaceNodeWithSimpleName<Parameter>
-
getModifiers
Return the modifiers of this parameter declaration.- Specified by:
getModifiers
in interfaceNodeWithModifiers<Parameter>
- Returns:
- modifiers
- See Also:
Modifier
-
setAnnotations
- Specified by:
setAnnotations
in interfaceNodeWithAnnotations<Parameter>
- Parameters:
annotations
- a null value is currently treated as an empty list. This behavior could change in the future, so please avoid passing null
-
setName
- Specified by:
setName
in interfaceNodeWithSimpleName<Parameter>
-
setModifiers
- Specified by:
setModifiers
in interfaceNodeWithModifiers<Parameter>
-
remove
-
getVarArgsAnnotations
-
setVarArgsAnnotations
-
clone
-
getMetaModel
- Overrides:
getMetaModel
in classNode
- Returns:
- get JavaParser specific node introspection information.
-
replace
-
resolve
- Specified by:
resolve
in interfaceResolvable<ResolvedParameterDeclaration>
-
isFinal
public boolean isFinal()Record components (parameters here) are implicitly final, even without the explicitly-added modifier. https://openjdk.java.net/jeps/359#Restrictions-on-records If wanting to find out if the keywordfinal
has been explicitly added to this parameter, you should usenode.hasModifier(Modifier.Keyword.FINAL)
- Specified by:
isFinal
in interfaceNodeWithFinalModifier<Parameter>
- Returns:
- true if the node parameter is explicitly final (keyword attached) or implicitly final (e.g. parameters to a record)
-