Datensatzklasse SortCriteria

java.lang.Object
java.lang.Record
de.kamillionlabs.hateoflux.utility.SortCriteria
Datensatzkomponenten:
property - the name of the property to sort by. Must not be null.
direction - the SortDirection indicating whether to sort in ascending or descending order.

public record SortCriteria(String property, SortDirection direction) extends Record
Represents sorting criteria for a specific property in a collection of data, allowing results to be ordered by the specified property and direction.

The SortCriteria record encapsulates the sorting behavior for a given property, which includes:

  • The property to sort by (e.g., a field name in an entity).
  • The sorting direction (e.g., ascending or descending), represented by SortDirection.

This record is typically used to specify sorting preferences when retrieving paginated data.

  • Konstruktordetails

    • SortCriteria

      public SortCriteria(String property, SortDirection direction)
      Erstellt eine Instanz einer Datensatzklasse SortCriteria.
      Parameter:
      property - Wert für die Datensatzkomponente property
      direction - Wert für die Datensatzkomponente direction
  • Methodendetails

    • by

      public static SortCriteria by(String property, SortDirection direction)
      Creates a new SortCriteria instance with the specified property and direction.
      Parameter:
      property - the name of the property to sort by. Must not be null.
      direction - the SortDirection indicating whether to sort in ascending or descending order.
      Gibt zurück:
      a new SortCriteria instance configured with the given property and direction.
    • toString

      public final String toString()
      Gibt eine Zeichenfolgendarstellung dieser Datensatzklasse zurück. Die Darstellung enthält den Namen der Klasse, gefolgt vom Namen und Wert jeder der Datensatzkomponenten.
      Angegeben von:
      toString in Klasse Record
      Gibt zurück:
      eine Zeichenfolgendarstellung dieses Objekts
    • hashCode

      public final int hashCode()
      Gibt einen Hashcodewert für diese Objekt zurück. Der Wert wird vom Hashcode jeder der Datensatzkomponenten abgeleitet.
      Angegeben von:
      hashCode in Klasse Record
      Gibt zurück:
      ein Hashcodewert für dieses Objekt
    • equals

      public final boolean equals(Object o)
      Gibt an, ob ein anderes Objekt diesem gleich ("equal to") ist. Die Objekte sind gleich, wenn das andere Objekt der gleichen Klasse angehört und alle Datensatzkomponenten gleich sind. Alle Komponenten in dieser Datensatzklasse werden verglichen mit Objects::equals(Object,Object).
      Angegeben von:
      equals in Klasse Record
      Parameter:
      o - das Objekt, mit dem verglichen wird
      Gibt zurück:
      true, wenn dieses Objekt gleich dem Argument o ist, andernfalls false.
    • property

      public String property()
      Gibt den Wert für die Datensatzkomponente property zurück.
      Gibt zurück:
      Wert der Datensatzkomponente property
    • direction

      public SortDirection direction()
      Gibt den Wert für die Datensatzkomponente direction zurück.
      Gibt zurück:
      Wert der Datensatzkomponente direction