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:

NodeWithAnnotations<FieldDeclaration>, NodeWithJavadoc<FieldDeclaration>, NodeWithModifiers<FieldDeclaration>, NodeWithVariables<FieldDeclaration>, Observable, Visitable, HasParentNode<Node>, Cloneable

public final class FieldDeclaration
extends BodyDeclaration<FieldDeclaration>
implements NodeWithJavadoc<FieldDeclaration>, NodeWithModifiers<FieldDeclaration>, NodeWithVariables<FieldDeclaration>

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; }

Author:

Julio Vilmar Gesser

Nested Class Summary

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

Node.ObserverRegistrationMode

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
FieldDeclaration()
FieldDeclaration(EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)
FieldDeclaration(EnumSet<Modifier> modifiers, NodeList<VariableDeclarator> variables)
FieldDeclaration(EnumSet<Modifier> modifiers, Type type, String name) Creates a FieldDeclaration.
FieldDeclaration(EnumSet<Modifier> modifiers, VariableDeclarator variable)
FieldDeclaration(Range range, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)

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.
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
JavadocComment	getJavaDoc() Gets the JavaDoc for this node.
EnumSet<Modifier>	getModifiers() Return the modifiers of this member declaration.
List<NodeList<?>>	getNodeLists() The list of NodeLists owned by this node.
NodeList<VariableDeclarator>	getVariables()
FieldDeclaration	setModifiers(EnumSet<Modifier> modifiers)
FieldDeclaration	setVariables(NodeList<VariableDeclarator> variables)

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

getAnnotations, setAnnotations

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

addOrphanComment, clone, containsWithin, equals, getAllContainedComments, getBegin, getChildNodes, getComment, getData, getEnd, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getRange, hasComment, hashCode, hasJavaDocComment, isPositionedAfter, isPositionedBefore, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeOrphanComment, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setRange, 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.NodeWithJavadoc

removeJavaDocComment, setJavaDocComment

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

addModifier, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile

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

addVariable, getCommonType, getElementType, getVariable, setVariable

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

addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent, setAnnotation

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Constructor Detail

FieldDeclaration

public FieldDeclaration()

FieldDeclaration

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

FieldDeclaration

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

FieldDeclaration

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

FieldDeclaration

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

FieldDeclaration

public FieldDeclaration(EnumSet<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 EnumSet<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(EnumSet<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<FieldDeclaration>

setVariables

public FieldDeclaration setVariables(NodeList<VariableDeclarator> variables)

Specified by:

setVariables in interface NodeWithVariables<FieldDeclaration>

getJavaDoc

public JavadocComment getJavaDoc()

Description copied from interface: NodeWithJavadoc

Gets the JavaDoc for this node. You can set the JavaDoc by calling setComment with a JavadocComment.

Specified by:

getJavaDoc in interface NodeWithJavadoc<FieldDeclaration>

Returns:

The JavaDoc for this node if it exists, null if it doesn't.

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

getNodeLists

public List<NodeList<?>> getNodeLists()

Description copied from class: Node

The list of NodeLists owned by this node.

Overrides:

getNodeLists in class BodyDeclaration<FieldDeclaration>