Module litebridge.db.spi
Package org.litebridgedb.db.spi.query

Record Class Limit

java.lang.Object
java.lang.Record
org.litebridgedb.db.spi.query.Limit
Record Components:
limit - An optional value specifying the maximum number of rows to return.
offset - An optional value specifying the starting position for the result set.
public record Limit(Optional<Integer> limit, Optional<Integer> offset) extends Record
Pagination parameters for database queries, defining a limit on the number of rows returned and an optional offset indicating the starting point for the result set.

This record is typically used in query-building processes to impose restrictions on the result set size, which is useful for implementing pagination or controlling resource usage during query execution.

See Also:

  • Constructor Details

    • Limit

      public Limit(Optional<Integer> limit, Optional<Integer> offset)
      Creates an instance of a Limit record class.
      Parameters:
      limit - the value for the limit record component
      offset - the value for the offset 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.

    • limit

      public Optional<Integer> limit()
      Returns the value of the limit record component.
      Returns:
      the value of the limit record component

    • offset

      public Optional<Integer> offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component