Module storm.foundation
Package st.orm

Record Class Order

java.lang.Object
java.lang.Record
st.orm.Order
Record Components:
field - the metamodel field to sort by.
descending - true for descending order, false for ascending.
public record Order(Metamodel<?,?> field, boolean descending) extends Record
A sort order for one metamodel field.

Pageable and Scrollable both order their results by a list of these, so a request built for one is expressed in the same vocabulary as the other.

Since:
1.14

  • Constructor Summary

    Constructors
    Constructor
    Description
    Order(Metamodel<?,?> field, boolean descending)
    Creates an instance of a Order record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Order
    asc(Metamodel<?,?> field)
    Returns an ascending order for the given field.
    static Order
    desc(Metamodel<?,?> field)
    Returns a descending order for the given field.
    boolean
    descending()
    Returns the value of the descending record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Metamodel<?,?>
    field()
    Returns the value of the field record component.
    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

    • Order

      public Order(Metamodel<?,?> field, boolean descending)
      Creates an instance of a Order record class.
      Parameters:
      field - the value for the field record component
      descending - the value for the descending record component

  • Method Details

    • asc

      public static Order asc(Metamodel<?,?> field)
      Returns an ascending order for the given field.
      Parameters:
      field - the metamodel field to sort by.
      Returns:
      an ascending order.

    • desc

      public static Order desc(Metamodel<?,?> field)
      Returns a descending order for the given field.
      Parameters:
      field - the metamodel field to sort by.
      Returns:
      a descending order.

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

    • field

      public Metamodel<?,?> field()
      Returns the value of the field record component.
      Returns:
      the value of the field record component

    • descending

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