Record Class UpdateResult

java.lang.Object
java.lang.Record
org.apache.cayenne.UpdateResult
All Implemented Interfaces:
QueryResult
public record UpdateResult(int[] counts) extends Record implements QueryResult
A QueryResult item holding the update counts produced by a non-selecting query. A regular update produces a single count, while a batch produces one count per batch element.
Since:
5.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    UpdateResult(int[] counts)
    Creates an instance of a UpdateResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    count()
    Returns the update count of a non-batch update.
    int[]
    counts()
    Returns the value of the counts 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.

    Methods inherited from class Object

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

  • Constructor Details

    • UpdateResult

      public UpdateResult(int[] counts)
      Creates an instance of a UpdateResult record class.
      Parameters:
      counts - the value for the counts record component

  • Method Details

    • count

      public int count()
      Returns the update count of a non-batch update.
      Throws:
      CayenneRuntimeException - if this item does not contain exactly one count.

    • 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.

    • counts

      public int[] counts()
      Returns the value of the counts record component.
      Returns:
      the value of the counts record component