Record Class PurityChecker.PurityResult.ImpurityReason

java.lang.Object
java.lang.Record
org.checkerframework.dataflow.util.PurityChecker.PurityResult.ImpurityReason
Record Components:
tree - the tree that makes the method impure
msgId - the message key for the reason that tree makes the method impure
Enclosing class:
PurityChecker.PurityResult

public static record PurityChecker.PurityResult.ImpurityReason(Tree tree, String msgId) extends Record
A reason that a method is impure: a tree, and a message key explaining what is wrong with it.
  • Constructor Summary

    Constructors
    Constructor
    Description
    ImpurityReason(Tree tree, String msgId)
    Creates an instance of a ImpurityReason record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the msgId record component.
    final String
    Returns a string representation of this record class.
    Returns the value of the tree record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • ImpurityReason

      public ImpurityReason(Tree tree, String msgId)
      Creates an instance of a ImpurityReason record class.
      Parameters:
      tree - the value for the tree record component
      msgId - the value for the msgId 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
    • msgId

      public String msgId()
      Returns the value of the msgId record component.
      Returns:
      the value of the msgId record component