Record Class SearchSort

java.lang.Object
java.lang.Record
codes.grow.packages.graylog.SearchSort
Record Components:
field - field to sort by
order - order (default descending)

public record SearchSort(String field, SortOrder order) extends Record
  • Constructor Details

    • SearchSort

      public SearchSort(String field, SortOrder order)
      Defaults the order to descending.
  • Method Details

    • asc

      public static SearchSort asc(String field)
      Ascending sort on field.
      Parameters:
      field - field
      Returns:
      the sort key
    • desc

      public static SearchSort desc(String field)
      Descending sort on field.
      Parameters:
      field - field
      Returns:
      the sort key
    • 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.
    • field

      public String field()
      Returns the value of the field record component.
      Returns:
      the value of the field record component
    • order

      public SortOrder order()
      Returns the value of the order record component.
      Returns:
      the value of the order record component