com.github.javaparser.ast.body

Class VariableDeclarator

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.body.VariableDeclarator

All Implemented Interfaces:

NodeWithRange<Node>, NodeWithSimpleName<VariableDeclarator>, NodeWithTokenRange<Node>, NodeWithType<VariableDeclarator,Type>, Observable, Visitable, HasParentNode<Node>, Cloneable

public final class VariableDeclarator
extends Node
implements NodeWithType<VariableDeclarator,Type>, NodeWithSimpleName<VariableDeclarator>

The declaration of a variable.
In int x = 14, y = 3; "x = 14" and " y = 3" are VariableDeclarators.

Author:

Julio Vilmar Gesser

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.ObserverRegistrationMode, Node.Parsedness

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration

Constructor Summary

Constructors

Constructor and Description
VariableDeclarator()
VariableDeclarator(TokenRange tokenRange, Type type, SimpleName name, Expression initializer) This constructor is used by the parser and is considered private.
VariableDeclarator(Type type, SimpleName name)
VariableDeclarator(Type type, SimpleName name, Expression initializer) Defines the declaration of a variable.
VariableDeclarator(Type type, String variableName)
VariableDeclarator(Type type, String variableName, Expression initializer)

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.
VariableDeclarator	clone()
protected void	customInitialization() Called in every constructor for node specific code.
Optional<Expression>	getInitializer()
VariableDeclaratorMetaModel	getMetaModel()
SimpleName	getName()
Type	getType() Gets the type
boolean	remove(Node node)
VariableDeclarator	removeInitializer()
boolean	replace(Node node, Node replacementNode)
VariableDeclarator	replaceInitializer(Expression replacement)
VariableDeclarator	setInitializer(Expression initializer) Sets the initializer expression
VariableDeclarator	setInitializer(String init) Will create a NameExpr with the initializer param
VariableDeclarator	setName(SimpleName name)
VariableDeclarator	setType(Type type) Sets the type

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, equals, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodeLists, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getTokenRange, hasComment, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeForced, removeOrphanComment, replaceComment, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, toString, toString, tryAddImportToParentCompilationUnit, unregister

Methods inherited from class java.lang.Object

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

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

setType, setType, tryAddImportToParentCompilationUnit

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

getNameAsString, setName

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

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

containsWithin, getBegin, getEnd, isPositionedAfter, isPositionedBefore

Constructor Detail

VariableDeclarator

public VariableDeclarator()

VariableDeclarator

public VariableDeclarator(Type type,
                          String variableName)

VariableDeclarator

public VariableDeclarator(Type type,
                          SimpleName name)

VariableDeclarator

public VariableDeclarator(Type type,
                          String variableName,
                          Expression initializer)

VariableDeclarator

public VariableDeclarator(Type type,
                          SimpleName name,
                          Expression initializer)

Defines the declaration of a variable.

Parameters:

name - The identifier for this variable. IE. The variables name.

initializer - What this variable should be initialized to. An AssignExpr is unnecessary as the = operator is already added.

VariableDeclarator

@Generated(value="com.github.javaparser.generator.core.node.MainConstructorGenerator")
public VariableDeclarator(TokenRange tokenRange,
                                                                                                                 Type type,
                                                                                                                 SimpleName name,
                                                                                                                 Expression initializer)

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

Method Detail

customInitialization

protected void customInitialization()

Description copied from class: Node

Called in every constructor for node specific code. It can't be written in the constructor itself because it will be overwritten during code generation.

Overrides:

customInitialization in class Node

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)

getInitializer

@Generated(value="com.github.javaparser.generator.core.node.PropertyGenerator")
public Optional<Expression> getInitializer()

getName

@Generated(value="com.github.javaparser.generator.core.node.PropertyGenerator")
public SimpleName getName()

Specified by:

getName in interface NodeWithSimpleName<VariableDeclarator>

setName

@Generated(value="com.github.javaparser.generator.core.node.PropertyGenerator")
public VariableDeclarator setName(SimpleName name)

Specified by:

setName in interface NodeWithSimpleName<VariableDeclarator>

setInitializer

@Generated(value="com.github.javaparser.generator.core.node.PropertyGenerator")
public VariableDeclarator setInitializer(Expression initializer)

Sets the initializer expression

Parameters:

initializer - the initializer expression, can be null

Returns:

this, the VariableDeclarator

setInitializer

public VariableDeclarator setInitializer(String init)

Will create a NameExpr with the initializer param

Parameters:

init - the initializer expression, can be null

Returns:

this, the VariableDeclarator

getType

@Generated(value="com.github.javaparser.generator.core.node.PropertyGenerator")
public Type getType()

Description copied from interface: NodeWithType

Gets the type

Specified by:

getType in interface NodeWithType<VariableDeclarator,Type>

Returns:

the type

setType

@Generated(value="com.github.javaparser.generator.core.node.PropertyGenerator")
public VariableDeclarator setType(Type type)

Description copied from interface: NodeWithType

Sets the type

Specified by:

setType in interface NodeWithType<VariableDeclarator,Type>

Parameters:

type - the type

Returns:

this

remove

@Generated(value="com.github.javaparser.generator.core.node.RemoveMethodGenerator")
public boolean remove(Node node)

Overrides:

remove in class Node

removeInitializer

@Generated(value="com.github.javaparser.generator.core.node.RemoveMethodGenerator")
public VariableDeclarator removeInitializer()

clone

@Generated(value="com.github.javaparser.generator.core.node.CloneGenerator")
public VariableDeclarator clone()

Overrides:

clone in class Node

getMetaModel

@Generated(value="com.github.javaparser.generator.core.node.GetMetaModelGenerator")
public VariableDeclaratorMetaModel getMetaModel()

Overrides:

getMetaModel in class Node

replaceInitializer

@Generated(value="com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
public VariableDeclarator replaceInitializer(Expression replacement)

replace

@Generated(value="com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
public boolean replace(Node node,
                                                                                                            Node replacementNode)

Overrides:

replace in class Node