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

Interface ModifierOwner

All Superinterfaces:
Annotatable, GenericNode<JavaNode>, JavaNode, JjtreeNode<JavaNode>, Node, Reportable, TextAvailableNode
All Known Subinterfaces:
ASTExecutableDeclaration, ASTTypeDeclaration
All Known Implementing Classes:
ASTAnnotationTypeDeclaration, ASTAnonymousClassDeclaration, ASTCatchParameter, ASTClassDeclaration, ASTCompactConstructorDeclaration, ASTConstructorDeclaration, ASTEnumConstant, ASTEnumDeclaration, ASTFieldDeclaration, ASTFormalParameter, ASTImplicitClassDeclaration, ASTLambdaParameter, ASTLocalVariableDeclaration, ASTMethodDeclaration, ASTRecordComponent, ASTRecordDeclaration, ASTTypePattern, ASTVariableId
public interface ModifierOwner extends Annotatable
A node that owns a modifier list.

ModifierOwner methods take into account the syntactic context of the declaration, e.g. hasModifiers(JModifier.PUBLIC) will always return true for a field declared inside an interface, regardless of whether the public modifier was specified explicitly or not. If you want to know whether the modifier was explicitly stated, use hasExplicitModifiers(JModifier, JModifier...).

Modifiers are accessible from XPath through the functions pmd:modifiers() and pmd:explicitModifiers(). They return a sequence, e.g. ("public", "static", "final").

Note: This interface was called AccessNode in PMD 6.

See Also:
  • GetModifiersFun

  • Method Details

    • getDeclaredAnnotations

      default NodeStream<ASTAnnotation> getDeclaredAnnotations()
      Description copied from interface: Annotatable
      Returns all annotations present on this node.
      Specified by:
      getDeclaredAnnotations in interface Annotatable

    • getModifiers

      default @NonNull ASTModifierList getModifiers()
      Returns the node representing the modifier list of this node.

    • getVisibility

      default ModifierOwner.Visibility getVisibility()
      Returns the visibility corresponding to the effective modifiers. Eg a public method will have visibility public, a local class will have visibility local. There cannot be any conflict with hasModifiers(JModifier, JModifier...)} on well-formed code (e.g. for any n, (n.getVisibility() == V_PROTECTED) == n.hasModifiers(PROTECTED))

      TODO a public method of a private class can be considered to be private we could probably add another method later on that takes this into account

    • getEffectiveVisibility

      default ModifierOwner.Visibility getEffectiveVisibility()
      Returns the "effective" visibility of a member. This is the minimum visibility of its enclosing type declarations. For example, a public method of a private class is "effectively private".

      Local declarations keep local visibility, eg a local variable somewhere in an anonymous class doesn't get anonymous visibility.

    • hasModifiers

      default boolean hasModifiers(JModifier mod1, JModifier... mod)
      Returns true if this node has all the given modifiers either explicitly written or inferred through context.

    • hasExplicitModifiers

      default boolean hasExplicitModifiers(JModifier mod1, JModifier... mod)
      Returns true if this node has all the given modifiers explicitly written in the source.

    • hasVisibility

      default boolean hasVisibility(ModifierOwner.Visibility visibility)
      Returns true if this node has the given visibility either explicitly written or inferred through context.
      See Also: