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

public Class FieldDeclaration

extends BodyDeclaration<FieldDeclaration>
implements NodeWithJavadoc<FieldDeclaration>, NodeWithVariables<FieldDeclaration>, NodeWithAccessModifiers<FieldDeclaration>, NodeWithStaticModifier<FieldDeclaration>, NodeWithFinalModifier<FieldDeclaration>, Resolvable<ResolvedFieldDeclaration>
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.modifiers.NodeWithStaticModifier, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithAccessModifiers, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithProtectedModifier, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPrivateModifier, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPublicModifier, com.github.javaparser.ast.nodeTypes.NodeWithVariables, com.github.javaparser.ast.nodeTypes.NodeWithJavadoc
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.*, .Node, .Generated, com.github.javaparser.ast.expr.AnnotationExpr, .AssignExpr, .AssignExpr.Operator, .NameExpr, com.github.javaparser.ast.nodeTypes.NodeWithJavadoc, .NodeWithVariables, com.github.javaparser.ast.nodeTypes.modifiers.NodeWithAccessModifiers, .NodeWithFinalModifier, .NodeWithStaticModifier, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.stmt.BlockStmt, .ReturnStmt, com.github.javaparser.ast.type.Type, .VoidType, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.FieldDeclarationMetaModel, .JavaParserMetaModel, .NonEmptyProperty, com.github.javaparser.resolution.Resolvable, com.github.javaparser.resolution.declarations.ResolvedFieldDeclaration, java.util.Optional, java.util.function.Consumer
The declaration of a field in a class. "private static int a=15*15;" in this example: class X { private static int a=15*15; }
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 method or the type.
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
private NodeList<Modifier>
modifiers

private NodeList<VariableDeclarator>
variables

Constructor Summary

AccessConstructor and Description
public
FieldDeclaration()

public
FieldDeclaration(NodeList<Modifier> modifiers, VariableDeclarator variable)

public
FieldDeclaration(NodeList<Modifier> modifiers, NodeList<VariableDeclarator> variables)

public
FieldDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)

public
FieldDeclaration(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)

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

public
FieldDeclaration(NodeList<Modifier>
modifiers
modifiers, Type
type
type, String
field name
name)

Creates a FieldDeclaration.

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 FieldDeclaration
asFieldDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.asFieldDeclaration.

public FieldDeclaration
clone()

Overrides com.github.javaparser.ast.body.BodyDeclaration.clone.

Creates and returns a copy of this object.
public MethodDeclaration

Returns:

the MethodDeclaration created
createGetter()

Create a getter for this field, will only work if this field declares only 1 identifier and if this field is already added to a ClassOrInterfaceDeclaration

public MethodDeclaration

Returns:

the MethodDeclaration created
createSetter()

Create a setter for this field, will only work if this field declares only 1 identifier and if this field is already added to a ClassOrInterfaceDeclaration

public FieldDeclarationMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.body.BodyDeclaration.getMetaModel.

public NodeList<Modifier>

Returns:

modifiers
getModifiers()

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

Return the modifiers of this member declaration.
public NodeList<VariableDeclarator>
getVariables()

Implements com.github.javaparser.ast.nodeTypes.NodeWithVariables.getVariables.

public void
ifFieldDeclaration(Consumer<FieldDeclaration> action)

Overrides com.github.javaparser.ast.body.BodyDeclaration.ifFieldDeclaration.

public boolean
isFieldDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.isFieldDeclaration.

public boolean
isTransient()

public boolean
isVolatile()

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.body.BodyDeclaration.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.body.BodyDeclaration.replace.

public ResolvedFieldDeclaration
resolve()

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

public FieldDeclaration
setModifiers(final NodeList<Modifier> modifiers)

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

public FieldDeclaration
setTransient(boolean set)

public FieldDeclaration
setVariables(final NodeList<VariableDeclarator> variables)

Implements com.github.javaparser.ast.nodeTypes.NodeWithVariables.setVariables.

public FieldDeclaration
setVolatile(boolean set)

public Optional<FieldDeclaration>
toFieldDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.toFieldDeclaration.

Inherited from com.github.javaparser.ast.body.BodyDeclaration:
asAnnotationDeclarationasAnnotationMemberDeclarationasCallableDeclarationasClassOrInterfaceDeclarationasConstructorDeclarationasEnumConstantDeclarationasEnumDeclarationasInitializerDeclarationasMethodDeclarationasTypeDeclarationgetAnnotationsifAnnotationDeclarationifAnnotationMemberDeclarationifCallableDeclarationifClassOrInterfaceDeclarationifConstructorDeclarationifEnumConstantDeclarationifEnumDeclarationifInitializerDeclarationifMethodDeclarationifTypeDeclarationisAnnotationDeclarationisAnnotationMemberDeclarationisCallableDeclarationisClassOrInterfaceDeclarationisConstructorDeclarationisEnumConstantDeclarationisEnumDeclarationisInitializerDeclarationisMethodDeclarationisTypeDeclarationsetAnnotationstoAnnotationDeclarationtoAnnotationMemberDeclarationtoCallableDeclarationtoClassOrInterfaceDeclarationtoConstructorDeclarationtoEnumConstantDeclarationtoEnumDeclarationtoInitializerDeclarationtoMethodDeclarationtoTypeDeclaration

Field Detail

modifiersback to summary
private NodeList<Modifier> modifiers
variablesback to summary
private NodeList<VariableDeclarator> variables
Annotations
@NonEmptyProperty

Constructor Detail

FieldDeclarationback to summary
public FieldDeclaration()
FieldDeclarationback to summary
public FieldDeclaration(NodeList<Modifier> modifiers, VariableDeclarator variable)
FieldDeclarationback to summary
public FieldDeclaration(NodeList<Modifier> modifiers, NodeList<VariableDeclarator> variables)
FieldDeclarationback to summary
public FieldDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)
Annotations
@AllFieldsConstructor
FieldDeclarationback to summary
public FieldDeclaration(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator
FieldDeclarationback to summary
public FieldDeclaration(NodeList<Modifier> modifiers, Type type, String name)

Creates a FieldDeclaration.

Parameters
modifiers:NodeList<Modifier>

modifiers

type:Type

type

name:String

field name

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
asFieldDeclarationback to summary
public FieldDeclaration asFieldDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.asFieldDeclaration.

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

Overrides com.github.javaparser.ast.body.BodyDeclaration.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:FieldDeclaration

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
createGetterback to summary
public MethodDeclaration createGetter()

Create a getter for this field, will only work if this field declares only 1 identifier and if this field is already added to a ClassOrInterfaceDeclaration

Returns:MethodDeclaration

the MethodDeclaration created

Exceptions
IllegalStateException:
if there is more than 1 variable identifier or if this field isn't attached to a class or enum
createSetterback to summary
public MethodDeclaration createSetter()

Create a setter for this field, will only work if this field declares only 1 identifier and if this field is already added to a ClassOrInterfaceDeclaration

Returns:MethodDeclaration

the MethodDeclaration created

Exceptions
IllegalStateException:
if there is more than 1 variable identifier or if this field isn't attached to a class or enum
getMetaModelback to summary
public FieldDeclarationMetaModel getMetaModel()

Overrides com.github.javaparser.ast.body.BodyDeclaration.getMetaModel.

Returns:FieldDeclarationMetaModel

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 member declaration.

Returns:NodeList<Modifier>

modifiers

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
See Also
Modifier
getVariablesback to summary
public NodeList<VariableDeclarator> getVariables()

Implements com.github.javaparser.ast.nodeTypes.NodeWithVariables.getVariables.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
ifFieldDeclarationback to summary
public void ifFieldDeclaration(Consumer<FieldDeclaration> action)

Overrides com.github.javaparser.ast.body.BodyDeclaration.ifFieldDeclaration.

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isFieldDeclarationback to summary
public boolean isFieldDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.isFieldDeclaration.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isTransientback to summary
public boolean isTransient()
isVolatileback to summary
public boolean isVolatile()
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.body.BodyDeclaration.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.body.BodyDeclaration.replace.

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

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

Annotations
@Override
setModifiersback to summary
public FieldDeclaration setModifiers(final NodeList<Modifier> modifiers)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setTransientback to summary
public FieldDeclaration setTransient(boolean set)
setVariablesback to summary
public FieldDeclaration setVariables(final NodeList<VariableDeclarator> variables)

Implements com.github.javaparser.ast.nodeTypes.NodeWithVariables.setVariables.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setVolatileback to summary
public FieldDeclaration setVolatile(boolean set)
toFieldDeclarationback to summary
public Optional<FieldDeclaration> toFieldDeclaration()

Overrides com.github.javaparser.ast.body.BodyDeclaration.toFieldDeclaration.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator