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>, NodeWithElementType<FieldDeclaration>, NodeWithJavaDoc<FieldDeclaration>, NodeWithModifiers<FieldDeclaration>, NodeWithVariables<FieldDeclaration>, Cloneable

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

Author:

Julio Vilmar Gesser

Field Summary

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION

Constructor Summary

Constructors

Constructor and Description
FieldDeclaration()
FieldDeclaration(EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type<?> elementType, NodeList<ArrayBracketPair> arrayBracketPairsAfterElementType, NodeList<VariableDeclarator> variables)
FieldDeclaration(EnumSet<Modifier> modifiers, Type<?> elementType, NodeList<VariableDeclarator> variables)
FieldDeclaration(EnumSet<Modifier> modifiers, Type<?> elementType, VariableDeclarator variable)
FieldDeclaration(Range range, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, Type<?> elementType, NodeList<VariableDeclarator> variables, NodeList<ArrayBracketPair> arrayBracketPairsAfterElementType)

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.
static FieldDeclaration	create(EnumSet<Modifier> modifiers, Type<?> type, String name) Creates a FieldDeclaration.
static FieldDeclaration	create(EnumSet<Modifier> modifiers, Type<?> type, VariableDeclarator variable) Creates a FieldDeclaration.
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
NodeList<ArrayBracketPair>	getArrayBracketPairsAfterElementType()
Type	getElementType()
Optional<JavadocComment>	getJavaDoc() Gets the JavaDoc for this node.
EnumSet<Modifier>	getModifiers() Return the modifiers of this member declaration.
NodeList<VariableDeclarator>	getVariables()
FieldDeclaration	setArrayBracketPairsAfterElementType(NodeList<ArrayBracketPair> arrayBracketPairsAfterType)
FieldDeclaration	setElementType(Type elementType)
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, getBackwardsCompatibleChildrenNodes, getBegin, getChildrenNodes, getComment, getEnd, getNodesByType, getOrphanComments, getParentNode, getParentNodeOfType, getRange, getUserData, hashCode, isPositionedAfter, isPositionedBefore, remove, setAsParentNodeOf, setAsParentNodeOf, setAsParentNodeOf, setBegin, setBlockComment, setComment, setEnd, setLineComment, setParentNode, setRange, setUserData, toString, toStringWithoutComments, tryAddImportToParentCompilationUnit

Methods inherited from class java.lang.Object

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

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

setJavaDocComment

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

setElementType, setElementType

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

addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent

Constructor Detail

FieldDeclaration

public FieldDeclaration()

FieldDeclaration

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

FieldDeclaration

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

FieldDeclaration

public FieldDeclaration(EnumSet<Modifier> modifiers,
                        NodeList<AnnotationExpr> annotations,
                        Type<?> elementType,
                        NodeList<ArrayBracketPair> arrayBracketPairsAfterElementType,
                        NodeList<VariableDeclarator> variables)

FieldDeclaration

public FieldDeclaration(Range range,
                        EnumSet<Modifier> modifiers,
                        NodeList<AnnotationExpr> annotations,
                        Type<?> elementType,
                        NodeList<VariableDeclarator> variables,
                        NodeList<ArrayBracketPair> arrayBracketPairsAfterElementType)

Method Detail

create

public static FieldDeclaration create(EnumSet<Modifier> modifiers,
                                      Type<?> type,
                                      VariableDeclarator variable)

Creates a FieldDeclaration.

Parameters:

modifiers - modifiers

type - type

variable - variable declarator

Returns:

instance of FieldDeclaration

create

public static FieldDeclaration create(EnumSet<Modifier> modifiers,
                                      Type<?> type,
                                      String name)

Creates a FieldDeclaration.

Parameters:

modifiers - modifiers

type - type

name - field name

Returns:

instance of FieldDeclaration

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

R - the type the return value of the visitor

A - the type the argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor

Returns:

the result of the visit

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from class: Node

Accept method for visitor support.

Specified by:

accept in class Node

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor

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 Optional<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 optional JavaDoc for this node

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

getElementType

public Type getElementType()

Specified by:

getElementType in interface NodeWithElementType<FieldDeclaration>

Returns:

the element type

setElementType

public FieldDeclaration setElementType(Type elementType)

Specified by:

setElementType in interface NodeWithElementType<FieldDeclaration>

Parameters:

elementType - the element elementType

Returns:

this

getArrayBracketPairsAfterElementType

public NodeList<ArrayBracketPair> getArrayBracketPairsAfterElementType()

Specified by:

getArrayBracketPairsAfterElementType in interface NodeWithElementType<FieldDeclaration>

Returns:

the array brackets in this position: class C { int[] abc; }

setArrayBracketPairsAfterElementType

public FieldDeclaration setArrayBracketPairsAfterElementType(NodeList<ArrayBracketPair> arrayBracketPairsAfterType)

Specified by:

setArrayBracketPairsAfterElementType in interface NodeWithElementType<FieldDeclaration>