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

Class ASTModifierList

java.lang.Object
net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
net.sourceforge.pmd.lang.java.ast.ASTModifierList
All Implemented Interfaces:
net.sourceforge.pmd.lang.ast.impl.GenericNode<JavaNode>, net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode<JavaNode>, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.ast.TextAvailableNode, JavaNode, net.sourceforge.pmd.reporting.Reportable
public final class ASTModifierList extends net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>
List of modifiers of a declaration.

This class keeps track of two modifier sets: the explicit one, which is the modifiers that appeared in the source, and the effective one, which includes modifiers implicitly given by the context of the node. 




 ModifierList         ::= Modifier*

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


 LocalVarModifierList ::= ( "final" | Annotation )*

 AnnotationList       ::= Annotation*

 EmptyModifierList    ::= ()

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected JSymbolTable
    symbolTable
     

    Fields inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

    id

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

    COORDS_COMPARATOR

  • Method Summary

    Modifier and Type
    Method
    Description
    final <P, R> R
    acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor, P data)
     
    protected <P, R> R
    acceptVisitor(JavaVisitor<? super P,? extends R> visitor, P data)
     
    protected void
    addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
     
    protected void
    enlargeLeft(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)
     
    Set<JModifier>
    getEffectiveModifiers()
    Returns the declared modifiers, plus the modifiers that are implicitly bestowed by the context or the type of this declaration.
    Set<JModifier>
    getExplicitModifiers()
    Returns the set of modifiers written out in the source explicitly.
    Annotatable
    getOwner()
    Returns the node owning this modifier list.
    final @NonNull ASTCompilationUnit
    getRoot()
     
    @NonNull JSymbolTable
    getSymbolTable()
    Returns the symbol table for the program point represented by this node.
    TypeSystem
    getTypeSystem()
    Returns the type system with which this node was created.
    final String
    getXPathNodeName()
     
    boolean
    hasAll(JModifier mod1, JModifier... mods)
    Returns true if the effective modifiers contain all of the mentioned modifiers.
    boolean
    hasAllExplicitly(JModifier mod1, JModifier... mods)
    Returns true if the explicit modifiers contain all of the mentioned modifiers.
    boolean
    hasAny(JModifier mod1, JModifier... mods)
    Returns true if the effective modifiers contain any of the mentioned modifiers.
    boolean
    hasAnyExplicitly(JModifier mod1, JModifier... mods)
    Returns true if the explicit modifiers contain any of the mentioned modifiers.
    protected void
    insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
     
    void
    jjtClose()
     
    protected void
    removeChildAtIndex(int childIndex)
     
    protected void
    setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
     
    protected void
    setFirstToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
     
    protected void
    setImage(String image)
     
    protected void
    setLastToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
     

    Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

    compareLocation, fitTokensToChildren, getFirstToken, getImage, getLastToken, getTextRegion, jjtOpen, toString

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

    children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, remove, setParent

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

    ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling

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

    getEnclosingType

    Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode

    getFirstToken, getLastToken, tokens

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

    ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, getTextDocument, getUserMap, getXPathAttributesIterator, hasImageEqualTo, isFindBoundary

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

    getOriginalText, getText, getTextRegion

  • Field Details

  • Method Details

    • acceptVisitor

      protected <P, R> R acceptVisitor(JavaVisitor<? super P,? extends R> visitor, P data)

    • getExplicitModifiers

      public Set<JModifier> getExplicitModifiers()
      Returns the set of modifiers written out in the source explicitly. The returned set is unmodifiable.

    • getEffectiveModifiers

      public Set<JModifier> getEffectiveModifiers()
      Returns the declared modifiers, plus the modifiers that are implicitly bestowed by the context or the type of this declaration. E.g. an interface is implicitly abstract, while an interface field is implicitly static. The returned set is unmodifiable.

    • getOwner

      public Annotatable getOwner()
      Returns the node owning this modifier list.

    • hasAll

      public boolean hasAll(JModifier mod1, JModifier... mods)
      Returns true if the effective modifiers contain all of the mentioned modifiers.
      Parameters:
      mod1 - First mod
      mods - Other mods

    • hasAllExplicitly

      public boolean hasAllExplicitly(JModifier mod1, JModifier... mods)
      Returns true if the explicit modifiers contain all of the mentioned modifiers.
      Parameters:
      mod1 - First mod
      mods - Other mods

    • hasAny

      public boolean hasAny(JModifier mod1, JModifier... mods)
      Returns true if the effective modifiers contain any of the mentioned modifiers.
      Parameters:
      mod1 - First mod
      mods - Other mods

    • hasAnyExplicitly

      public boolean hasAnyExplicitly(JModifier mod1, JModifier... mods)
      Returns true if the explicit modifiers contain any of the mentioned modifiers.
      Parameters:
      mod1 - First mod
      mods - Other mods

    • jjtClose

      public void jjtClose()
      Overrides:
      jjtClose in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • acceptVisitor

      public final <P, R> R acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor, P data)
      Specified by:
      acceptVisitor in interface net.sourceforge.pmd.lang.ast.Node

    • addChild

      protected void addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
      Overrides:
      addChild in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • insertChild

      protected void insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
      Overrides:
      insertChild in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • removeChildAtIndex

      protected void removeChildAtIndex(int childIndex)
      Overrides:
      removeChildAtIndex in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • setImage

      protected void setImage(String image)
      Overrides:
      setImage in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • setFirstToken

      protected void setFirstToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
      Overrides:
      setFirstToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • setLastToken

      protected void setLastToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
      Overrides:
      setLastToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • enlargeLeft

      protected void enlargeLeft(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)
      Overrides:
      enlargeLeft in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • setChild

      protected void setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
      Overrides:
      setChild in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • getSymbolTable

      public @NonNull JSymbolTable getSymbolTable()
      Description copied from interface: JavaNode
      Returns the symbol table for the program point represented by this node.
      Specified by:
      getSymbolTable in interface JavaNode

    • getTypeSystem

      public TypeSystem getTypeSystem()
      Description copied from interface: JavaNode
      Returns the type system with which this node was created. This is the object responsible for representing types in the compilation unit.
      Specified by:
      getTypeSystem in interface JavaNode

    • getRoot

      public final @NonNull ASTCompilationUnit getRoot()
      Specified by:
      getRoot in interface JavaNode
      Specified by:
      getRoot in interface net.sourceforge.pmd.lang.ast.Node

    • getXPathNodeName

      public final String getXPathNodeName()
      Specified by:
      getXPathNodeName in interface net.sourceforge.pmd.lang.ast.Node