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

Class ASTFormalParameter

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.ASTFormalParameter
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, Annotatable, JavaNode, ModifierOwner, TypeNode, net.sourceforge.pmd.reporting.Reportable
public final class ASTFormalParameter extends net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode> implements ModifierOwner, TypeNode
Formal parameter node for a formal parameter list. This is distinct from lambda parameters.

The varargs ellipsis "..." is parsed as an array dimension in the type node. 


 FormalParameter ::= LocalVarModifierList Type VariableId

  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.sourceforge.pmd.lang.java.ast.ModifierOwner

    ModifierOwner.Visibility

  • 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)
     
    ASTFormalParameters
    getOwnerList()
    Returns the list of formal parameters containing this param.
    final @NonNull ASTCompilationUnit
    getRoot()
     
    @NonNull JSymbolTable
    getSymbolTable()
    Returns the symbol table for the program point represented by this node.
    @NonNull JTypeMirror
    getTypeMirror(TypingContext ctx)
     
    ASTType
    getTypeNode()
    Returns the type node of this formal parameter.
    TypeSystem
    getTypeSystem()
    Returns the type system with which this node was created.
    @NonNull ASTVariableId
    getVarId()
    Returns the declarator ID of this formal parameter.
    ModifierOwner.Visibility
    getVisibility()
    Returns the visibility corresponding to the effective modifiers.
    final String
    getXPathNodeName()
     
    protected void
    insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
     
    boolean
    isFinal()
     
    boolean
    isVarargs()
    Returns true if this node is a varargs parameter.
    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.java.ast.Annotatable

    getAnnotation, isAnnotationPresent, isAnnotationPresent, isAnyAnnotationPresent

    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, getRoot, getSymbolTable, getTypeSystem

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

    getFirstToken, getLastToken, tokens

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

    getDeclaredAnnotations, getEffectiveVisibility, getModifiers, hasExplicitModifiers, hasModifiers, hasVisibility

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

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

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

    getOriginalText, getText, getTextRegion

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

    getTypeMirror

  • Field Details

  • Method Details

    • getVisibility

      public ModifierOwner.Visibility getVisibility()
      Description copied from interface: ModifierOwner
      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 ModifierOwner.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

      Specified by:
      getVisibility in interface ModifierOwner

    • getOwnerList

      public ASTFormalParameters getOwnerList()
      Returns the list of formal parameters containing this param.

    • isVarargs

      public boolean isVarargs()
      Returns true if this node is a varargs parameter. Then, the type node is an ArrayType, and its last dimension is varargs.

    • acceptVisitor

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

    • getVarId

      public @NonNull ASTVariableId getVarId()
      Returns the declarator ID of this formal parameter.

    • getTypeNode

      public ASTType getTypeNode()
      Returns the type node of this formal parameter.

      If this formal parameter is varargs, the type node is an ASTArrayType.

    • getTypeMirror

      public @NonNull JTypeMirror getTypeMirror(TypingContext ctx)
      Specified by:
      getTypeMirror in interface TypeNode

    • isFinal

      public boolean isFinal()

    • 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