com.github.javaparser.ast.body

Class FieldDeclaration

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.body.BodyDeclaration<FieldDeclaration>

com.github.javaparser.ast.body.FieldDeclaration

All Implemented Interfaces:

NodeWithAccessModifiers<FieldDeclaration>, NodeWithFinalModifier<FieldDeclaration>, NodeWithPrivateModifier<FieldDeclaration>, NodeWithProtectedModifier<FieldDeclaration>, NodeWithPublicModifier<FieldDeclaration>, NodeWithStaticModifier<FieldDeclaration>, NodeWithAnnotations<FieldDeclaration>, NodeWithJavadoc<FieldDeclaration>, NodeWithModifiers<FieldDeclaration>, NodeWithRange<Node>, NodeWithTokenRange<Node>, NodeWithVariables<FieldDeclaration>, Observable, Visitable, HasParentNode<Node>, Resolvable<ResolvedFieldDeclaration>, Cloneable

public class FieldDeclaration
extends BodyDeclaration<FieldDeclaration>
implements NodeWithJavadoc<FieldDeclaration>, NodeWithVariables<FieldDeclaration>, NodeWithAccessModifiers<FieldDeclaration>, NodeWithStaticModifier<FieldDeclaration>, NodeWithFinalModifier<FieldDeclaration>, Resolvable<ResolvedFieldDeclaration>

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

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
FieldDeclaration()
FieldDeclaration(NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)
FieldDeclaration(NodeList<Modifier> modifiers, NodeList<VariableDeclarator> variables)
FieldDeclaration(NodeList<Modifier> modifiers, Type type, String name) Creates a FieldDeclaration.
FieldDeclaration(NodeList<Modifier> modifiers, VariableDeclarator variable)
FieldDeclaration(TokenRange tokenRange, NodeList<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables) This constructor is used by the parser and is considered private.

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.
FieldDeclaration	asFieldDeclaration()
FieldDeclaration	clone()
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
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
FieldDeclarationMetaModel	getMetaModel()
NodeList<Modifier>	getModifiers() Return the modifiers of this member declaration.
NodeList<VariableDeclarator>	getVariables()
void	ifFieldDeclaration(Consumer<FieldDeclaration> action)
boolean	isFieldDeclaration()
boolean	isFinal()
boolean	isPublic()
boolean	isStatic()
boolean	isTransient()
boolean	isVolatile()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
ResolvedFieldDeclaration	resolve()
FieldDeclaration	setModifiers(NodeList<Modifier> modifiers)
FieldDeclaration	setTransient(boolean set)
FieldDeclaration	setVariables(NodeList<VariableDeclarator> variables)
FieldDeclaration	setVolatile(boolean set)
Optional<FieldDeclaration>	toFieldDeclaration()

Methods inherited from class com.github.javaparser.ast.body.BodyDeclaration

asAnnotationDeclaration, asAnnotationMemberDeclaration, asCallableDeclaration, asClassOrInterfaceDeclaration, asCompactConstructorDeclaration, asConstructorDeclaration, asEnumConstantDeclaration, asEnumDeclaration, asInitializerDeclaration, asMethodDeclaration, asRecordDeclaration, asTypeDeclaration, getAnnotations, ifAnnotationDeclaration, ifAnnotationMemberDeclaration, ifCallableDeclaration, ifClassOrInterfaceDeclaration, ifCompactConstructorDeclaration, ifConstructorDeclaration, ifEnumConstantDeclaration, ifEnumDeclaration, ifInitializerDeclaration, ifMethodDeclaration, ifRecordDeclaration, ifTypeDeclaration, isAnnotationDeclaration, isAnnotationMemberDeclaration, isCallableDeclaration, isClassOrInterfaceDeclaration, isCompactConstructorDeclaration, isConstructorDeclaration, isEnumConstantDeclaration, isEnumDeclaration, isInitializerDeclaration, isMethodDeclaration, isRecordDeclaration, isTypeDeclaration, setAnnotations, toAnnotationDeclaration, toAnnotationMemberDeclaration, toCallableDeclaration, toClassOrInterfaceDeclaration, toCompactConstructorDeclaration, toConstructorDeclaration, toEnumConstantDeclaration, toEnumDeclaration, toInitializerDeclaration, toMethodDeclaration, toRecordDeclaration, toTypeDeclaration

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

addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findByRange, findCompilationUnit, findData, 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.NodeWithJavadoc

getComment, getJavadoc, getJavadocComment, hasJavaDocComment, removeJavaDocComment, setComment, setJavadocComment, setJavadocComment, setJavadocComment, setJavadocComment

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

addVariable, calculateMaximumCommonType, getCommonType, getElementType, getMaximumCommonType, getVariable, setAllTypes, setVariable

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPublicModifier

setPublic

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithPrivateModifier

isPrivate, setPrivate

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithProtectedModifier

isProtected, setProtected

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.modifiers.NodeWithStaticModifier

setStatic

Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithFinalModifier

setFinal

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

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

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

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

FieldDeclaration

public FieldDeclaration()

FieldDeclaration

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

FieldDeclaration

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

FieldDeclaration

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

FieldDeclaration

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

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

FieldDeclaration

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

Creates a FieldDeclaration.

Parameters:

modifiers - modifiers

type - type

name - field name

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)

getModifiers

public NodeList<Modifier> getModifiers()

Return the modifiers of this member declaration.

Specified by:

getModifiers in interface NodeWithModifiers<FieldDeclaration>

Returns:

modifiers

See Also:

Modifier

getVariables

public NodeList<VariableDeclarator> getVariables()

Specified by:

getVariables in interface NodeWithVariables<FieldDeclaration>

setModifiers

public FieldDeclaration setModifiers(NodeList<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<FieldDeclaration>

setVariables

public FieldDeclaration setVariables(NodeList<VariableDeclarator> variables)

Specified by:

setVariables in interface NodeWithVariables<FieldDeclaration>

createGetter

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:

the MethodDeclaration created

Throws:

IllegalStateException - if there is more than 1 variable identifier or if this field isn't attached to a class or enum

createSetter

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:

the MethodDeclaration created

Throws:

IllegalStateException - if there is more than 1 variable identifier or if this field isn't attached to a class or enum

isTransient

public boolean isTransient()

isVolatile

public boolean isVolatile()

setTransient

public FieldDeclaration setTransient(boolean set)

setVolatile

public FieldDeclaration setVolatile(boolean set)

isStatic

public boolean isStatic()

Specified by:

isStatic in interface NodeWithStaticModifier<FieldDeclaration>

Returns:

true, if the modifier static is explicitly added to this node. If the node is implicitly static without an explicit modifier (e.g. nested records), this method should be overridden.

isFinal

public boolean isFinal()

Specified by:

isFinal in interface NodeWithFinalModifier<FieldDeclaration>

Returns:

true, if the modifier final is explicitly added to this node. If the node is implicitly final without an explicit modifier (e.g. records, and components of a record), this method should be overridden.

isPublic

public boolean isPublic()

Specified by:

isPublic in interface NodeWithPublicModifier<FieldDeclaration>

remove

public boolean remove(Node node)

Overrides:

remove in class BodyDeclaration<FieldDeclaration>

clone

public FieldDeclaration clone()

Overrides:

clone in class BodyDeclaration<FieldDeclaration>

getMetaModel

public FieldDeclarationMetaModel getMetaModel()

Overrides:

getMetaModel in class BodyDeclaration<FieldDeclaration>

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class BodyDeclaration<FieldDeclaration>

isFieldDeclaration

public boolean isFieldDeclaration()

Overrides:

isFieldDeclaration in class BodyDeclaration<FieldDeclaration>

asFieldDeclaration

public FieldDeclaration asFieldDeclaration()

Overrides:

asFieldDeclaration in class BodyDeclaration<FieldDeclaration>

ifFieldDeclaration

public void ifFieldDeclaration(Consumer<FieldDeclaration> action)

Overrides:

ifFieldDeclaration in class BodyDeclaration<FieldDeclaration>

resolve

public ResolvedFieldDeclaration resolve()

Specified by:

resolve in interface Resolvable<ResolvedFieldDeclaration>

toFieldDeclaration

public Optional<FieldDeclaration> toFieldDeclaration()

Overrides:

toFieldDeclaration in class BodyDeclaration<FieldDeclaration>