Package net.sourceforge.pmd.lang.java.ast

Class ASTFieldDeclaration

java.lang.Object

net.sourceforge.pmd.lang.ast.AbstractNode

net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessNode

net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessTypeNode

net.sourceforge.pmd.lang.java.ast.ASTFieldDeclaration

All Implemented Interfaces:

java.lang.Iterable<ASTVariableDeclaratorId>, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.ast.SignedNode<ASTFieldDeclaration>, AccessNode, Annotatable, Dimensionable, JavaNode, TypeNode, net.sourceforge.pmd.lang.symboltable.ScopedNode

public class ASTFieldDeclaration
extends AbstractJavaAccessTypeNode
implements Dimensionable, net.sourceforge.pmd.lang.ast.SignedNode<ASTFieldDeclaration>, java.lang.Iterable<ASTVariableDeclaratorId>

Represents a field declaration in the body of a type declaration.

This statement may define several variables, possibly of different types (see ASTVariableDeclaratorId.getType()). The nodes corresponding to the declared variables are accessible through iterator().

AccessNode methods take into account the syntactic context of the declaration, e.g. isPublic() will always return true if the field is declared inside an interface, regardless of whether the public modifier was specified or not. If you want to know whether the modifier was explicitly stated, use e.g isSyntacticallyPublic().

 FieldDeclaration ::= Modifiers Type VariableDeclarator ( "," VariableDeclarator )*

 Modifiers        ::= "public" | "static" | "protected" | "private"
                    | "final"  | "abstract" | "synchronized"
                    | "native" | "transient" | "volatile" | "strictfp"
                    | "default"  | Annotation

 

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessTypeNode

typeDefinition

Fields inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

parser

Fields inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

beginColumn, beginLine, childIndex, children, endColumn, endLine, firstToken, id, lastToken, parent

Fields inherited from interface net.sourceforge.pmd.lang.java.ast.AccessNode

ABSTRACT, DEFAULT, FINAL, NATIVE, PRIVATE, PROTECTED, PUBLIC, STATIC, STRICTFP, SYNCHRONIZED, TRANSIENT, VOLATILE

Constructor Summary

Constructors

Constructor	Description
ASTFieldDeclaration(int id)	Deprecated.
ASTFieldDeclaration(JavaParser p, int id)	Deprecated.

Method Summary

Modifier and Type	Method	Description
ASTAnnotation	getAnnotation(java.lang.String annotQualifiedName)	Get specific annotaion on this node.
int	getArrayDepth()	Deprecated.
java.util.List<ASTAnnotation>	getDeclaredAnnotations()	Get all annotations present on this node.
JavaFieldSignature	getSignature()
java.lang.Class<?>	getType()	Deprecated. FieldDeclaration may declare several variables with a different type It won't implement TypeNode anymore come 7.0.0
JavaTypeDefinition	getTypeDefinition()	Deprecated. FieldDeclaration may declare several variables with a different type It won't implement TypeNode anymore come 7.0.0
java.lang.String	getVariableName()	Deprecated. FieldDeclaration may declare several variables, so this is not exhaustive Iterate on the VariableDeclaratorIds instead
boolean	isAnnotationMember()
boolean	isAnnotationPresent(java.lang.String annotQualifiedName)	Checks whether the annotation is present on this node.
boolean	isAnyAnnotationPresent(java.util.Collection<java.lang.String> annotQualifiedNames)	Checks whether any annotation is present on this node.
boolean	isArray()	Deprecated.
boolean	isFinal()
boolean	isInterfaceMember()
boolean	isPackagePrivate()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
boolean	isSyntacticallyFinal()
boolean	isSyntacticallyPublic()
boolean	isSyntacticallyStatic()
java.util.Iterator<ASTVariableDeclaratorId>	iterator()	Returns an iterator over the ids of the fields declared in this statement.
java.lang.Object	jjtAccept(JavaParserVisitor visitor, java.lang.Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.

Methods inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessTypeNode

setType, setTypeDefinition

Methods inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessNode

getModifiers, isAbstract, isDefault, isNative, isStrictfp, isSynchronized, isTransient, isVolatile, setAbstract, setDefault, setFinal, setModifiers, setNative, setPrivate, setProtected, setPublic, setStatic, setStrictfp, setSynchronized, setTransient, setVolatile

Methods inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

childrenAccept, comment, comment, getScope, getXPathNodeName, jjtClose, jjtOpen, setScope

Methods inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

appendElement, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getNthParent, getParentsOfType, getUserData, getXPathAttributesIterator, hasDecendantOfAnyType, hasDescendantMatchingXPath, hasDescendantOfAnyType, hasDescendantOfType, hasImageEqualTo, isFindBoundary, isSingleLine, jjtAddChild, jjtGetChild, jjtGetChildIndex, jjtGetFirstToken, jjtGetId, jjtGetLastToken, jjtGetNumChildren, jjtGetParent, jjtSetChildIndex, jjtSetFirstToken, jjtSetLastToken, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData, testingOnlySetBeginColumn, testingOnlySetBeginLine, testingOnlySetEndColumn, testingOnlySetEndLine, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaNode

childrenAccept, setScope

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getNthParent, getParentsOfType, getUserData, getXPathAttributesIterator, getXPathNodeName, hasDescendantMatchingXPath, hasDescendantOfType, hasImageEqualTo, isFindBoundary, jjtAddChild, jjtClose, jjtGetChild, jjtGetChildIndex, jjtGetId, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetChildIndex, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData

Methods inherited from interface net.sourceforge.pmd.lang.symboltable.ScopedNode

getScope

Constructor Detail

ASTFieldDeclaration

@InternalApi
@Deprecated
public ASTFieldDeclaration(int id)

Deprecated.

ASTFieldDeclaration

@InternalApi
@Deprecated
public ASTFieldDeclaration(JavaParser p,
                           int id)

Deprecated.

Method Detail

jjtAccept

public java.lang.Object jjtAccept(JavaParserVisitor visitor,
                                  java.lang.Object data)

Description copied from interface: JavaNode

Calls back the visitor's visit method corresponding to the runtime type of this Node.

Specified by:

jjtAccept in interface JavaNode

Overrides:

jjtAccept in class AbstractJavaNode

Parameters:

visitor - Visitor to dispatch

data - Visit data

isSyntacticallyPublic

public boolean isSyntacticallyPublic()

isPublic

public boolean isPublic()

Specified by:

isPublic in interface AccessNode

Overrides:

isPublic in class AbstractJavaAccessNode

isSyntacticallyStatic

public boolean isSyntacticallyStatic()

isStatic

public boolean isStatic()

Specified by:

isStatic in interface AccessNode

Overrides:

isStatic in class AbstractJavaAccessNode

isSyntacticallyFinal

public boolean isSyntacticallyFinal()

isFinal

public boolean isFinal()

Specified by:

isFinal in interface AccessNode

Overrides:

isFinal in class AbstractJavaAccessNode

isPrivate

public boolean isPrivate()

Specified by:

isPrivate in interface AccessNode

Overrides:

isPrivate in class AbstractJavaAccessNode

isPackagePrivate

public boolean isPackagePrivate()

Specified by:

isPackagePrivate in interface AccessNode

Overrides:

isPackagePrivate in class AbstractJavaAccessNode

isProtected

public boolean isProtected()

Specified by:

isProtected in interface AccessNode

Overrides:

isProtected in class AbstractJavaAccessNode

isAnnotationMember

public boolean isAnnotationMember()

isInterfaceMember

public boolean isInterfaceMember()

isArray

@Deprecated
public boolean isArray()

Deprecated.

Specified by:

isArray in interface Dimensionable

getArrayDepth

@Deprecated
public int getArrayDepth()

Deprecated.

Specified by:

getArrayDepth in interface Dimensionable

getVariableName

@Deprecated
public java.lang.String getVariableName()

Deprecated.

FieldDeclaration may declare several variables, so this is not exhaustive Iterate on the VariableDeclaratorIds instead

Gets the variable name of this field. This method searches the first VariableDeclartorId node and returns its image or null if the child node is not found.

Returns:

a String representing the name of the variable

getSignature

public JavaFieldSignature getSignature()

Specified by:

getSignature in interface net.sourceforge.pmd.lang.ast.SignedNode<ASTFieldDeclaration>

iterator

public java.util.Iterator<ASTVariableDeclaratorId> iterator()

Returns an iterator over the ids of the fields declared in this statement.

Specified by:

iterator in interface java.lang.Iterable<ASTVariableDeclaratorId>

getType

@Deprecated
public java.lang.Class<?> getType()

Deprecated.

FieldDeclaration may declare several variables with a different type It won't implement TypeNode anymore come 7.0.0

Description copied from interface: TypeNode

Get the Java Class associated with this node.

Specified by:

getType in interface TypeNode

Overrides:

getType in class AbstractJavaAccessTypeNode

Returns:

The Java Class, may return null.

getTypeDefinition

@Deprecated
public JavaTypeDefinition getTypeDefinition()

Deprecated.

FieldDeclaration may declare several variables with a different type It won't implement TypeNode anymore come 7.0.0

Description copied from interface: TypeNode

Get the TypeDefinition associated with this node. The Class object contained in the TypeDefinition will always be equal to that which is returned by getType().

Specified by:

getTypeDefinition in interface TypeNode

Overrides:

getTypeDefinition in class AbstractJavaAccessTypeNode

Returns:

The TypeDefinition, may return null

getDeclaredAnnotations

public java.util.List<ASTAnnotation> getDeclaredAnnotations()

Description copied from interface: Annotatable

Get all annotations present on this node.

Specified by:

getDeclaredAnnotations in interface Annotatable

Returns:

all annotations present on this node.

getAnnotation

public ASTAnnotation getAnnotation(java.lang.String annotQualifiedName)

Description copied from interface: Annotatable

Get specific annotaion on this node.

Specified by:

getAnnotation in interface Annotatable

Parameters:

annotQualifiedName - qulified name of the annotation.

Returns:

ASTAnnotaion node if the annotation is present on this node, else null

isAnnotationPresent

public boolean isAnnotationPresent(java.lang.String annotQualifiedName)

Description copied from interface: Annotatable

Checks whether the annotation is present on this node.

Specified by:

isAnnotationPresent in interface Annotatable

Parameters:

annotQualifiedName - qulified name of the annotation.

Returns:

true if the annotation is present on this node, else false

isAnyAnnotationPresent

public boolean isAnyAnnotationPresent(java.util.Collection<java.lang.String> annotQualifiedNames)

Description copied from interface: Annotatable

Checks whether any annotation is present on this node.

Specified by:

isAnyAnnotationPresent in interface Annotatable

Parameters:

annotQualifiedNames - collection that cotains qulified name of annotations.

Returns:

true if any annotation is present on this node, else false