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

Record Class OrderBy

java.lang.Object
java.lang.Record
org.litebridgedb.db.spi.query.OrderBy
Record Components:
column - The column to order by.
asc - A boolean indicating whether the order is ascending (true) or descending (false).
public record OrderBy(Column column, boolean asc) extends Record
Ordering clause in an SQL query.

This record specifies the column on which the query results should be ordered and determines whether the ordering is ascending or descending.

It is typically used in query-building processes to define the order of rows in the result set.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    OrderBy(Column column, boolean asc)
    Creates an instance of a OrderBy record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    asc()
    Returns the value of the asc record component.
    Column
    column()
    Returns the value of the column 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 java.lang.Object

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

  • Constructor Details

    • OrderBy

      public OrderBy(Column column, boolean asc)
      Creates an instance of a OrderBy record class.
      Parameters:
      column - the value for the column record component
      asc - the value for the asc 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • column

      public Column column()
      Returns the value of the column record component.
      Returns:
      the value of the column record component

    • asc

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