Record Class Commented

java.lang.Object
java.lang.Record
com.google.errorprone.util.Commented
public record Commented(Tree tree, com.google.common.collect.ImmutableList<ErrorProneComment> beforeComments, com.google.common.collect.ImmutableList<ErrorProneComment> afterComments) extends Record
Class to hold AST nodes annotated with the comments that are associated with them

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Commented.Position
    Identifies the position of a comment relative to the associated treenode.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Commented(Tree tree, com.google.common.collect.ImmutableList<ErrorProneComment> beforeComments, com.google.common.collect.ImmutableList<ErrorProneComment> afterComments)
    Creates an instance of a Commented record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.common.collect.ImmutableList<ErrorProneComment>
    afterComments()
    Returns the value of the afterComments record component.
    com.google.common.collect.ImmutableList<ErrorProneComment>
    beforeComments()
    Returns the value of the beforeComments record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    Tree
    tree()
    Returns the value of the tree record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Commented

      public Commented(Tree tree, com.google.common.collect.ImmutableList<ErrorProneComment> beforeComments, com.google.common.collect.ImmutableList<ErrorProneComment> afterComments)
      Creates an instance of a Commented record class.
      Parameters:
      tree - the value for the tree record component
      beforeComments - the value for the beforeComments record component
      afterComments - the value for the afterComments record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • tree

      public Tree tree()
      Returns the value of the tree record component.
      Returns:
      the value of the tree record component

    • beforeComments

      public com.google.common.collect.ImmutableList<ErrorProneComment> beforeComments()
      Returns the value of the beforeComments record component.
      Returns:
      the value of the beforeComments record component

    • afterComments

      public com.google.common.collect.ImmutableList<ErrorProneComment> afterComments()
      Returns the value of the afterComments record component.
      Returns:
      the value of the afterComments record component