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

Class ASTRecordComponent

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.ASTRecordComponent
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, SymbolDeclaratorNode, TypeNode, net.sourceforge.pmd.reporting.Reportable
public final class ASTRecordComponent extends net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode> implements ModifierOwner, SymbolDeclaratorNode
Defines a single component of a RecordDeclaration (JDK 16 feature).

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

Record components declare a field, and if a canonical constructor is synthesized by the compiler, also a formal parameter (which is in scope in the body of a compact record constructor). They also may imply the declaration of an accessor method.

  • The symbol exposed by the ASTVariableId is the field symbol.
  • The symbol exposed by this node (ASTRecordComponent) is a JRecordComponentSymbol.
  • The formal parameter symbol is accessible in the formal parameter list of the JConstructorSymbol for the canonical constructor.
  • The symbol for the accessor method can be found in the declared methods of the symbol for the record declaration. TODO when we support usage search this needs to be more straightforward 

 RecordComponent ::= Annotation* 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)
     
    final @NonNull ASTCompilationUnit
    getRoot()
     
    JRecordComponentSymbol
    getSymbol()
    Returns the symbol this node declares.
    @NonNull JSymbolTable
    getSymbolTable()
    Returns the symbol table for the program point represented by this node.
    @NonNull JTypeMirror
    getTypeMirror()
    Returns the compile-time type of this node.
    @NonNull JTypeMirror
    getTypeMirror(TypingContext context)
     
    ASTType
    getTypeNode()
     
    TypeSystem
    getTypeSystem()
    Returns the type system with which this node was created.
    ASTVariableId
    getVarId()
     
    final String
    getXPathNodeName()
     
    protected void
    insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
     
    boolean
    isVarargs()
    Returns true if this component's corresponding formal parameter in the canonical constructor of the record is varargs.
    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, getVisibility, 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.java.ast.SymbolDeclaratorNode

    getSymbol

    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)

    • isVarargs

      public boolean isVarargs()
      Returns true if this component's corresponding formal parameter in the canonical constructor of the record is varargs. The type node of this component is in this case an ASTArrayType.

    • getTypeNode

      public ASTType getTypeNode()

    • getVarId

      public ASTVariableId getVarId()

    • getSymbol

      public JRecordComponentSymbol getSymbol()
      Description copied from interface: SymbolDeclaratorNode
      Returns the symbol this node declares.
      Specified by:
      getSymbol in interface SymbolDeclaratorNode

    • getTypeMirror

      public @NonNull JTypeMirror getTypeMirror()
      Description copied from interface: TypeNode
      Returns the compile-time type of this node. For example, for a string literal, returns the type mirror for String, for a method call, returns the return type of the call, etc.

      This method ignores conversions applied to the value of the node because of its context. For example, in 1 + "", the numeric literal will have type int, but it is converted to String by the surrounding concatenation expression. Similarly, in Collections.singletonList(1), the ASTNumericLiteral node has type int, but the type of the method formal is Integer, and boxing is applied at runtime. Possibly, an API will be added to expose this information.

      Specified by:
      getTypeMirror in interface TypeNode
      Returns:
      The type mirror. Never returns null; if the type is unresolved, returns TypeSystem.UNKNOWN.

    • getTypeMirror

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

    • 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