Package 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 final 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, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY
-
-
Constructor Summary
Constructors Constructor Description FieldDeclaration()
FieldDeclaration(TokenRange tokenRange, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)
This constructor is used by the parser and is considered private.FieldDeclaration(EnumSet<Modifier> modifiers, VariableDeclarator variable)
FieldDeclaration(EnumSet<Modifier> modifiers, NodeList<VariableDeclarator> variables)
FieldDeclaration(EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)
FieldDeclaration(EnumSet<Modifier> modifiers, Type type, String name)
Creates aFieldDeclaration
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <R,A>
Raccept(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 ClassOrInterfaceDeclarationMethodDeclaration
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 ClassOrInterfaceDeclarationFieldDeclarationMetaModel
getMetaModel()
EnumSet<Modifier>
getModifiers()
Return the modifiers of this member declaration.NodeList<VariableDeclarator>
getVariables()
void
ifFieldDeclaration(Consumer<FieldDeclaration> action)
boolean
isFieldDeclaration()
boolean
isTransient()
boolean
isVolatile()
boolean
remove(Node node)
boolean
replace(Node node, Node replacementNode)
ResolvedFieldDeclaration
resolve()
FieldDeclaration
setModifiers(EnumSet<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, asConstructorDeclaration, asEnumConstantDeclaration, asEnumDeclaration, asInitializerDeclaration, asMethodDeclaration, asTypeDeclaration, getAnnotations, ifAnnotationDeclaration, ifAnnotationMemberDeclaration, ifCallableDeclaration, ifClassOrInterfaceDeclaration, ifConstructorDeclaration, ifEnumConstantDeclaration, ifEnumDeclaration, ifInitializerDeclaration, ifMethodDeclaration, ifTypeDeclaration, isAnnotationDeclaration, isAnnotationMemberDeclaration, isCallableDeclaration, isClassOrInterfaceDeclaration, isConstructorDeclaration, isEnumConstantDeclaration, isEnumDeclaration, isInitializerDeclaration, isMethodDeclaration, isTypeDeclaration, setAnnotations, toAnnotationDeclaration, toAnnotationMemberDeclaration, toCallableDeclaration, toClassOrInterfaceDeclaration, toConstructorDeclaration, toEnumConstantDeclaration, toEnumDeclaration, toInitializerDeclaration, toMethodDeclaration, toTypeDeclaration
-
Methods inherited from class com.github.javaparser.ast.Node
addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, hasComment, hashCode, 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.HasParentNode
findAncestor, findAncestor, findParent, getAncestorOfType
-
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.ast.nodeTypes.modifiers.NodeWithFinalModifier
isFinal, setFinal
-
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.NodeWithModifiers
addModifier, removeModifier, setModifier
-
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.modifiers.NodeWithPublicModifier
isPublic, setPublic
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange
containsWithin, getBegin, getEnd, isPositionedAfter, isPositionedBefore
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.modifiers.NodeWithStaticModifier
isStatic, setStatic
-
Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithVariables
addVariable, getCommonType, getElementType, getMaximumCommonType, getVariable, setVariable
-
-
-
-
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(TokenRange tokenRange, EnumSet<Modifier> modifiers, NodeList<AnnotationExpr> annotations, NodeList<VariableDeclarator> variables)
This constructor is used by the parser and is considered private.
-
FieldDeclaration
public FieldDeclaration(EnumSet<Modifier> modifiers, Type type, String name)
Creates aFieldDeclaration
.- Parameters:
modifiers
- modifierstype
- typename
- 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 interfaceVisitable
- Type Parameters:
R
- the type of the return value of the visitorA
- the type the user argument passed to the visitor- Parameters:
v
- the visitor implementationarg
- 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.
-
getModifiers
public EnumSet<Modifier> getModifiers()
Return the modifiers of this member declaration.- Specified by:
getModifiers
in interfaceNodeWithModifiers<FieldDeclaration>
- Returns:
- modifiers
- See Also:
Modifier
-
getVariables
public NodeList<VariableDeclarator> getVariables()
- Specified by:
getVariables
in interfaceNodeWithVariables<FieldDeclaration>
-
setModifiers
public FieldDeclaration setModifiers(EnumSet<Modifier> modifiers)
- Specified by:
setModifiers
in interfaceNodeWithModifiers<FieldDeclaration>
-
setVariables
public FieldDeclaration setVariables(NodeList<VariableDeclarator> variables)
- Specified by:
setVariables
in interfaceNodeWithVariables<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)
-
remove
public boolean remove(Node node)
- Overrides:
remove
in classBodyDeclaration<FieldDeclaration>
-
clone
public FieldDeclaration clone()
- Overrides:
clone
in classBodyDeclaration<FieldDeclaration>
-
getMetaModel
public FieldDeclarationMetaModel getMetaModel()
- Overrides:
getMetaModel
in classBodyDeclaration<FieldDeclaration>
- Returns:
- get JavaParser specific node introspection information.
-
replace
public boolean replace(Node node, Node replacementNode)
- Overrides:
replace
in classBodyDeclaration<FieldDeclaration>
-
isFieldDeclaration
public boolean isFieldDeclaration()
- Overrides:
isFieldDeclaration
in classBodyDeclaration<FieldDeclaration>
-
asFieldDeclaration
public FieldDeclaration asFieldDeclaration()
- Overrides:
asFieldDeclaration
in classBodyDeclaration<FieldDeclaration>
-
ifFieldDeclaration
public void ifFieldDeclaration(Consumer<FieldDeclaration> action)
- Overrides:
ifFieldDeclaration
in classBodyDeclaration<FieldDeclaration>
-
resolve
public ResolvedFieldDeclaration resolve()
- Specified by:
resolve
in interfaceResolvable<ResolvedFieldDeclaration>
-
toFieldDeclaration
public Optional<FieldDeclaration> toFieldDeclaration()
- Overrides:
toFieldDeclaration
in classBodyDeclaration<FieldDeclaration>
-
-