Class Sort.Order

java.lang.Object
io.micronaut.data.model.Sort.Order
Direct Known Subclasses:
ExpressionOrder
Enclosing interface:
Sort
public static class Sort.Order extends Object
The ordering of results.
Since:
1.0
Author:
graemerocher

  • Constructor Details

    • Order

      public Order(String property)
      Constructs an order for the given property in ascending order.
      Parameters:
      property - The property

    • Order

      public Order(String property, Sort.Order.Direction direction, boolean ignoreCase)
      Constructs an order for the given property with the given direction.
      Parameters:
      property - The property
      direction - The direction
      ignoreCase - Whether to ignore case

    • Order

      @Creator public Order(String property, Sort.Order.Direction direction, boolean ignoreCase, @Nullable Sort.Order.NullOrdering nullOrdering)
      Constructs an order for the given property with the given direction and null ordering.
      Parameters:
      property - The property
      direction - The direction
      ignoreCase - Whether to ignore case
      nullOrdering - Where to place null values relative to non-null values, null is treated as Sort.Order.NullOrdering.NONE so that payloads written before 5.2 still deserialize
      Since:
      5.2

  • Method Details

    • getNullOrdering

      public Sort.Order.NullOrdering getNullOrdering()
      Returns:
      Where null values are placed relative to non-null values
      Since:
      5.2

    • isIgnoreCase

      public boolean isIgnoreCase()
      Returns:
      Whether to ignore case when sorting

    • getDirection

      public Sort.Order.Direction getDirection()
      Returns:
      The direction order by

    • getProperty

      public String getProperty()
      Returns:
      The property name to order by

    • reverse

      public Sort.Order reverse()
      Create an order that is reversed to current.
      Returns:
      A new instance of order that is reversed.

    • desc

      public static Sort.Order desc(String property)
      Creates a new order for the given property in descending order.
      Parameters:
      property - The property
      Returns:
      The order instance

    • asc

      public static Sort.Order asc(String property)
      Creates a new order for the given property in ascending order.
      Parameters:
      property - The property
      Returns:
      The order instance

    • desc

      public static Sort.Order desc(String property, boolean ignoreCase)
      Creates a new order for the given property in descending order.
      Parameters:
      property - The property
      ignoreCase - Whether to ignore case
      Returns:
      The order instance

    • asc

      public static Sort.Order asc(String property, boolean ignoreCase)
      Creates a new order for the given property in ascending order.
      Parameters:
      property - The property
      ignoreCase - Whether to ignore case
      Returns:
      The order instance

    • of

      public static Sort.Order of(String property, boolean ignoreCase)
      Creates a new order for the given property in ascending order.
      Parameters:
      property - The property
      ignoreCase - Whether to ignore case
      Returns:
      The order instance
      Since:
      4.13

    • isAscending

      public boolean isAscending()
      Returns:
      Is the order ascending

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object