Package org.checkerframework.checker.calledmethods

Record Class EnsuresCalledMethodOnExceptionContract

java.lang.Object
java.lang.Record
org.checkerframework.checker.calledmethods.EnsuresCalledMethodOnExceptionContract
Record Components:
expression - the expression described by this postcondition
method - the method this postcondition promises to call
public record EnsuresCalledMethodOnExceptionContract(String expression, String method) extends Record
A postcondition contract that a method calls the given method on the given expression when that method throws an exception.

Instances of this class are plain old immutable data with no interesting behavior.

See Also:

  • Constructor Details

    • EnsuresCalledMethodOnExceptionContract

      public EnsuresCalledMethodOnExceptionContract(String expression, String method)
      Creates an instance of a EnsuresCalledMethodOnExceptionContract record class.
      Parameters:
      expression - the value for the expression record component
      method - the value for the method 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.

    • expression

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

    • method

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