Record Class PaginationRenderingPlan.Top

java.lang.Object
java.lang.Record
org.hibernate.dialect.sql.ast.spi.PaginationRenderingPlan.Top
Record Components:
addOffset - whether the bound value represents fetch plus offset
parenthesize - whether the bound value must be parenthesized
All Implemented Interfaces:
PaginationRenderingPlan
Enclosing interface:
PaginationRenderingPlan
public static record PaginationRenderingPlan.Top(boolean addOffset, boolean parenthesize) extends Record implements PaginationRenderingPlan

A top clause rendered immediately after select.

Examples are select top (10) ... and, when addOffset is true, select top (15) ... for offset 5 and fetch 10. Since top cannot express the offset itself, Hibernate also skips the first five JDBC result rows in the latter case.

Since:
8.0

  • Constructor Details

    • Top

      public Top(boolean addOffset, boolean parenthesize)
      Creates an instance of a Top record class.
      Parameters:
      addOffset - the value for the addOffset record component
      parenthesize - the value for the parenthesize 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 the compare method from their corresponding wrapper classes.
      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.

    • addOffset

      public boolean addOffset()
      Returns the value of the addOffset record component.
      Returns:
      the value of the addOffset record component

    • parenthesize

      public boolean parenthesize()
      Returns the value of the parenthesize record component.
      Returns:
      the value of the parenthesize record component