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

Constructors

Constructor and Description
Parameter()
Parameter(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type type, boolean isVarArgs, NodeList<AnnotationExpr> varArgsAnnotations, SimpleName name)
Parameter(NodeList<Modifier> modifiers, Type type, SimpleName name)
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.
Parameter(Type type, SimpleName name)
Parameter(Type type, String name) Creates a new Parameter.

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.
Parameter	clone()
NodeList<AnnotationExpr>	getAnnotations()
ParameterMetaModel	getMetaModel()
NodeList<Modifier>	getModifiers() Return the modifiers of this parameter declaration.
SimpleName	getName()
Type	getType() Gets the type
NodeList<AnnotationExpr>	getVarArgsAnnotations()
boolean	isFinal() Record components (parameters here) are implicitly final, even without the explicitly-added modifier.
boolean	isVarArgs()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
ResolvedParameterDeclaration	resolve()
Parameter	setAnnotations(NodeList<AnnotationExpr> annotations)
Parameter	setModifiers(NodeList<Modifier> modifiers)
Parameter	setName(SimpleName name)
Parameter	setType(Type type) Sets the type
Parameter	setVarArgs(boolean isVarArgs)
Parameter	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.ast.nodeTypes.NodeWithType

getTypeAsString, setType, setType, tryAddImportToParentCompilationUnit

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.NodeWithSimpleName

getNameAsExpression, getNameAsString, setName

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.HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

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

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

Parameter

public Parameter()

Parameter

public Parameter(Type type,
                 SimpleName name)

Parameter

public Parameter(Type type,
                 String name)

Creates a new Parameter.

Parameters:

type - type of the parameter

name - name of the parameter

Parameter

public Parameter(NodeList<Modifier> modifiers,
                 Type type,
                 SimpleName name)

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 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)

getType

public Type getType()

Description copied from interface: NodeWithType

Gets the type

Specified by:

getType in interface NodeWithType<Parameter,Type>

Returns:

the type

isVarArgs

public boolean isVarArgs()

setType

public Parameter setType(Type type)

Description copied from interface: NodeWithType

Sets the type

Specified by:

setType in interface NodeWithType<Parameter,Type>

Parameters:

type - the type

Returns:

this

setVarArgs

public Parameter setVarArgs(boolean isVarArgs)

getAnnotations

public NodeList<AnnotationExpr> getAnnotations()

Specified by:

getAnnotations in interface NodeWithAnnotations<Parameter>

Returns:

the list returned could be immutable (in that case it will be empty)

getName

public SimpleName getName()

Specified by:

getName in interface NodeWithSimpleName<Parameter>

getModifiers

public NodeList<Modifier> getModifiers()

Return the modifiers of this parameter declaration.

Specified by:

getModifiers in interface NodeWithModifiers<Parameter>

Returns:

modifiers

See Also:

Modifier

setAnnotations

public Parameter setAnnotations(NodeList<AnnotationExpr> annotations)

Specified by:

setAnnotations in interface NodeWithAnnotations<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

public Parameter setName(SimpleName name)

Specified by:

setName in interface NodeWithSimpleName<Parameter>

setModifiers

public Parameter setModifiers(NodeList<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<Parameter>

remove

public boolean remove(Node node)

Overrides:

remove in class Node

getVarArgsAnnotations

public NodeList<AnnotationExpr> getVarArgsAnnotations()

setVarArgsAnnotations

public Parameter setVarArgsAnnotations(NodeList<AnnotationExpr> varArgsAnnotations)

clone

public Parameter clone()

Overrides:

clone in class Node

getMetaModel

public ParameterMetaModel getMetaModel()

Overrides:

getMetaModel in class Node

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Node

resolve

public ResolvedParameterDeclaration resolve()

Specified by:

resolve in interface Resolvable<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 keyword final has been explicitly added to this parameter, you should use node.hasModifier(Modifier.Keyword.FINAL)

Specified by:

isFinal in interface NodeWithFinalModifier<Parameter>

Returns:

true if the node parameter is explicitly final (keyword attached) or implicitly final (e.g. parameters to a record)