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:
GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, JavaNode, Reportable
public final class ASTModifierList extends 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 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 AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • acceptVisitor

      public final <P, R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)
      Specified by:
      acceptVisitor in interface Node

    • addChild

      protected void addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
      Overrides:
      addChild in class 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 AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

    • removeChildAtIndex

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

    • setImage

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

    • setFirstToken

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

    • setLastToken

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

    • enlargeLeft

      protected void enlargeLeft(JavaccToken child)
      Overrides:
      enlargeLeft in class 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 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 Node

    • getXPathNodeName

      public final String getXPathNodeName()
      Specified by:
      getXPathNodeName in interface Node