Top Description Fields Constructors Methods
com.github.javaparser.ast.body

public Class Parameter

extends Node
implements NodeWithType<Parameter, Type>, NodeWithAnnotations<Parameter>, NodeWithSimpleName<Parameter>, NodeWithFinalModifier<Parameter>, Resolvable<ResolvedParameterDeclaration>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.resolution.Resolvable, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithFinalModifier, com.github.javaparser.ast.nodeTypes.NodeWithModifiers, com.github.javaparser.ast.nodeTypes.NodeWithSimpleName, com.github.javaparser.ast.nodeTypes.NodeWithAnnotations, com.github.javaparser.ast.nodeTypes.NodeWithType
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Modifier, .Node, .NodeList, .Generated, com.github.javaparser.ast.expr.AnnotationExpr, .SimpleName, com.github.javaparser.ast.nodeTypes.NodeWithAnnotations, .NodeWithSimpleName, .NodeWithType, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithFinalModifier, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.type.ClassOrInterfaceType, .Type, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.JavaParserMetaModel, .ParameterMetaModel, com.github.javaparser.TokenRange, com.github.javaparser.resolution.Resolvable, com.github.javaparser.resolution.declarations.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

Field Summary

Modifier and TypeField and Description
private NodeList<AnnotationExpr>
annotations

private boolean
isVarArgs

private NodeList<Modifier>
modifiers

private SimpleName
name

private Type
type

private NodeList<AnnotationExpr>
varArgsAnnotations

Inherited from com.github.javaparser.ast.Node:
ABSOLUTE_BEGIN_LINEABSOLUTE_END_LINENODE_BY_BEGIN_POSITIONprettyPrinterNoCommentsConfigurationSYMBOL_RESOLVER_KEY

Constructor Summary

AccessConstructor and Description
public
Parameter()

public
Parameter(Type type, SimpleName name)

public
Parameter(Type
type of the parameter
type, String
name of the parameter
name)

Creates a new Parameter.

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

public
Parameter(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type type, boolean isVarArgs, NodeList<AnnotationExpr> varArgsAnnotations, SimpleName name)

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 Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public Parameter
clone()

Overrides com.github.javaparser.ast.Node.clone.

Creates and returns a copy of this object.
public NodeList<AnnotationExpr>

Returns:

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

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.getAnnotations.

public ParameterMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

public NodeList<Modifier>

Returns:

modifiers
getModifiers()

Implements com.github.javaparser.ast.nodeTypes.NodeWithModifiers.getModifiers.

Return the modifiers of this parameter declaration.
public SimpleName
getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.getName.

public Type
getType()

Implements com.github.javaparser.ast.nodeTypes.NodeWithType.getType.

Gets the type
public NodeList<AnnotationExpr>
getVarArgsAnnotations()

public boolean
isVarArgs()

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.Node.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.Node.replace.

public ResolvedParameterDeclaration
resolve()

Implements com.github.javaparser.resolution.Resolvable.resolve.

public Parameter
setAnnotations(final NodeList<AnnotationExpr>
a null value is currently treated as an empty list. This behavior could change in the future, so please avoid passing null
annotations)

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

public Parameter
setModifiers(final NodeList<Modifier> modifiers)

Implements com.github.javaparser.ast.nodeTypes.NodeWithModifiers.setModifiers.

public Parameter
setName(final SimpleName name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.setName.

public Parameter
setType(final Type
the type
type)

Implements com.github.javaparser.ast.nodeTypes.NodeWithType.setType.

Sets the type
public Parameter
setVarArgs(final boolean isVarArgs)

public Parameter
setVarArgsAnnotations(final NodeList<AnnotationExpr> varArgsAnnotations)

Inherited from com.github.javaparser.ast.Node:
addOrphanCommentcontainsDatacustomInitializationequalsfindAllfindAllfindCompilationUnitfindFirstfindFirstfindFirstfindRootNodegetAllContainedCommentsgetChildNodesgetChildNodesByTypegetCommentgetDatagetDataKeysgetNodesByTypegetOrphanCommentsgetParentNodegetParentNodeForChildrengetParsedgetRangegetSymbolResolvergetTokenRangegetToStringPrettyPrinterConfigurationhashCodeisAncestorOfisRegisterednotifyPropertyChangeregisterregisterregisterForSubtreeremoveremoveCommentremoveDataremoveForcedremoveOrphanCommentreplacesetAsParentNodeOfsetAsParentNodeOfsetBlockCommentsetCommentsetDatasetLineCommentsetParentNodesetParsedsetRangesetTokenRangesetToStringPrettyPrinterConfigurationstreamstreamtoStringtoStringtryAddImportToParentCompilationUnitunregisterwalkwalkwalk

Field Detail

annotationsback to summary
private NodeList<AnnotationExpr> annotations
isVarArgsback to summary
private boolean isVarArgs
modifiersback to summary
private NodeList<Modifier> modifiers
nameback to summary
private SimpleName name
typeback to summary
private Type type
varArgsAnnotationsback to summary
private NodeList<AnnotationExpr> varArgsAnnotations

Constructor Detail

Parameterback to summary
public Parameter()
Parameterback to summary
public Parameter(Type type, SimpleName name)
Parameterback to summary
public Parameter(Type type, String name)

Creates a new Parameter.

Parameters
type:Type

type of the parameter

name:String

name of the parameter

Parameterback to summary
public Parameter(NodeList<Modifier> modifiers, Type type, SimpleName name)
Parameterback to summary
public Parameter(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type type, boolean isVarArgs, NodeList<AnnotationExpr> varArgsAnnotations, SimpleName name)
Annotations
@AllFieldsConstructor
Parameterback to summary
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.

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
cloneback to summary
public Parameter clone()

Overrides com.github.javaparser.ast.Node.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Parameter

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getAnnotationsback to summary
public NodeList<AnnotationExpr> getAnnotations()

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.getAnnotations.

Returns:NodeList<AnnotationExpr>

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

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public ParameterMetaModel getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

Returns:ParameterMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getModifiersback to summary
public NodeList<Modifier> getModifiers()

Implements com.github.javaparser.ast.nodeTypes.NodeWithModifiers.getModifiers.

Return the modifiers of this parameter declaration.

Returns:NodeList<Modifier>

modifiers

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
See Also
Modifier
getNameback to summary
public SimpleName getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.getName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getTypeback to summary
public Type getType()

Implements com.github.javaparser.ast.nodeTypes.NodeWithType.getType.

Doc from com.github.javaparser.ast.nodeTypes.NodeWithType.getType.

Gets the type

Returns:Type

the type

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getVarArgsAnnotationsback to summary
public NodeList<AnnotationExpr> getVarArgsAnnotations()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
isVarArgsback to summary
public boolean isVarArgs()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.Node.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.Node.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
resolveback to summary
public ResolvedParameterDeclaration resolve()

Implements com.github.javaparser.resolution.Resolvable.resolve.

Annotations
@Override
setAnnotationsback to summary
public Parameter setAnnotations(final NodeList<AnnotationExpr> annotations)

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

Parameters
annotations:NodeList<AnnotationExpr>

a null value is currently treated as an empty list. This behavior could change in the future, so please avoid passing null

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setModifiersback to summary
public Parameter setModifiers(final NodeList<Modifier> modifiers)

Implements com.github.javaparser.ast.nodeTypes.NodeWithModifiers.setModifiers.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setNameback to summary
public Parameter setName(final SimpleName name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithSimpleName.setName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setTypeback to summary
public Parameter setType(final Type type)

Implements com.github.javaparser.ast.nodeTypes.NodeWithType.setType.

Doc from com.github.javaparser.ast.nodeTypes.NodeWithType.setType.

Sets the type

Parameters
type:Type

the type

Returns:Parameter

this

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setVarArgsback to summary
public Parameter setVarArgs(final boolean isVarArgs)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setVarArgsAnnotationsback to summary
public Parameter setVarArgsAnnotations(final NodeList<AnnotationExpr> varArgsAnnotations)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator