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 final 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 inint 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, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY
-
-
Constructor Summary
Constructors Constructor 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(Type type, SimpleName name)
Parameter(Type type, String 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <R,A>
Raccept(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 typeNodeList<AnnotationExpr>
getVarArgsAnnotations()
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 typeParameter
setVarArgs(boolean isVarArgs)
Parameter
setVarArgsAnnotations(NodeList<AnnotationExpr> varArgsAnnotations)
-
Methods inherited from class com.github.javaparser.ast.Node
addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, hasComment, hashCode, 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, findParent, getAncestorOfType
-
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
isFinal, 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, getBegin, getEnd, isPositionedAfter, isPositionedBefore
-
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 Detail
-
Parameter
public Parameter()
-
Parameter
public Parameter(Type type, SimpleName name)
-
Parameter
public Parameter(Type type, String name)
Creates a newParameter
.- Parameters:
type
- type of the parametername
- 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 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.
-
getType
public Type getType()
Description copied from interface:NodeWithType
Gets the type- Specified by:
getType
in interfaceNodeWithType<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 interfaceNodeWithType<Parameter,Type>
- Parameters:
type
- the type- Returns:
- this
-
setVarArgs
public Parameter setVarArgs(boolean isVarArgs)
-
getAnnotations
public NodeList<AnnotationExpr> getAnnotations()
- Specified by:
getAnnotations
in interfaceNodeWithAnnotations<Parameter>
- Returns:
- the list returned could be immutable (in that case it will be empty)
-
getName
public SimpleName getName()
- Specified by:
getName
in interfaceNodeWithSimpleName<Parameter>
-
getModifiers
public NodeList<Modifier> getModifiers()
Return the modifiers of this parameter declaration.- Specified by:
getModifiers
in interfaceNodeWithModifiers<Parameter>
- Returns:
- modifiers
- See Also:
Modifier
-
setAnnotations
public Parameter setAnnotations(NodeList<AnnotationExpr> annotations)
- 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
public Parameter setName(SimpleName name)
- Specified by:
setName
in interfaceNodeWithSimpleName<Parameter>
-
setModifiers
public Parameter setModifiers(NodeList<Modifier> modifiers)
- Specified by:
setModifiers
in interfaceNodeWithModifiers<Parameter>
-
getVarArgsAnnotations
public NodeList<AnnotationExpr> getVarArgsAnnotations()
-
setVarArgsAnnotations
public Parameter setVarArgsAnnotations(NodeList<AnnotationExpr> varArgsAnnotations)
-
getMetaModel
public ParameterMetaModel getMetaModel()
- Overrides:
getMetaModel
in classNode
- Returns:
- get JavaParser specific node introspection information.
-
resolve
public ResolvedParameterDeclaration resolve()
- Specified by:
resolve
in interfaceResolvable<ResolvedParameterDeclaration>
-
-