Sort.Order (Blazebit Persistence Integration DeltaSpike Data API 1.4.0-Alpha3 API)

java.lang.Object
- com.blazebit.persistence.deltaspike.data.Sort.Order

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Sort
```
public static class Sort.Order
extends java.lang.Object
implements java.io.Serializable
```
PropertyPath implements the pairing of an Sort.Direction and a property. It is used to provide input for Sort

Since:

1.2.0

Author:

Christian Beikov

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`Order(Sort.Direction direction, java.lang.String path)`	Creates a new `Sort.Order` with the given direction and path.
`Order(Sort.Direction direction, java.lang.String path, Sort.NullHandling nullHandling)`	Creates a new `Sort.Order` with the given direction, path and null handling.
`Order(java.lang.String path)`	Creates a new `Sort.Order` with the given path and `Sort.Direction.ASC`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`appendTo(java.lang.StringBuilder sb)`	Appends the string representation to the given `StringBuilder`.
`boolean`	`equals(java.lang.Object obj)`
`Sort.Direction`	`getDirection()`	Returns the sort direction.
`Sort.NullHandling`	`getNullHandling()`	Returns the `Sort.NullHandling`.
`java.lang.String`	`getPath()`	Returns the path of the Sort.Order.
`int`	`hashCode()`
`Sort.Order`	`ignoreCase()`	Returns a new `Sort.Order` with case insensitive sorting enabled.
`boolean`	`isAscending()`	Returns whether sorting for this property should be ascending.
`boolean`	`isDescending()`	Returns whether sorting for this path should be descending.
`boolean`	`isIgnoreCase()`	Returns whether or not the sort will be case sensitive.
`Sort.Order`	`nullsFirst()`	Returns a new `Sort.Order` with `Sort.NullHandling.NULLS_FIRST` as null handling.
`Sort.Order`	`nullsLast()`	Returns a new `Sort.Order` with `Sort.NullHandling.NULLS_LAST` as null handling.
`Sort.Order`	`nullsNative()`	Returns a new `Sort.Order` with `Sort.NullHandling.NATIVE` as null handling.
`java.lang.String`	`toString()`
`Sort.Order`	`with(Sort.Direction direction)`	Returns a new `Sort.Order` with the given `Sort.Direction`.
`Sort.Order`	`with(Sort.NullHandling nullHandling)`	Returns a new `Sort.Order` with the given `Sort.NullHandling`.
`Sort.Order`	`withPath(java.lang.String path)`	Returns a new `Sort.Order` with the same configuration as this `Sort.Order`, but the given path.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Order
```
public Order(Sort.Direction direction,
             java.lang.String path)
```
    Creates a new Sort.Order with the given direction and path.
    
    Parameters:
    
    direction - The Sort.Direction to use, defaults to Sort.Direction.ASC if null
    
    path - The path to sort by
  - Order
```
public Order(Sort.Direction direction,
             java.lang.String path,
             Sort.NullHandling nullHandling)
```
    Creates a new Sort.Order with the given direction, path and null handling.
    
    Parameters:
    
    direction - The Sort.Direction to use, defaults to Sort.Direction.ASC if null
    
    path - The path to sort by
    
    nullHandling - The Sort.NullHandling to use, defaults to Sort.NullHandling.NATIVE if null
  - Order
```
public Order(java.lang.String path)
```
    Creates a new Sort.Order with the given path and Sort.Direction.ASC.
    
    Parameters:
    
    path - The path to sort by
- Method Detail
  - getDirection
```
public Sort.Direction getDirection()
```
    Returns the sort direction.
    
    Returns:
    
    The sort direction
  - getPath
```
public java.lang.String getPath()
```
    Returns the path of the Sort.Order.
    
    Returns:
    
    The path to sort by
  - isAscending
```
public boolean isAscending()
```
    Returns whether sorting for this property should be ascending.
    
    Returns:
    
    true if sorting is ascending, false otherwise
  - isDescending
```
public boolean isDescending()
```
    Returns whether sorting for this path should be descending.
    
    Returns:
    
    true if sorting is descending, false otherwise
  - isIgnoreCase
```
public boolean isIgnoreCase()
```
    Returns whether or not the sort will be case sensitive.
    
    Returns:
    
    true if case insensitive, false otherwise
  - with
```
public Sort.Order with(Sort.Direction direction)
```
    Returns a new Sort.Order with the given Sort.Direction.
    
    Parameters:
    
    direction - The Sort.Direction to use, defaults to Sort.Direction.ASC if null
    
    Returns:
    
    A new Sort.Order with the given Sort.Direction
  - withPath
```
public Sort.Order withPath(java.lang.String path)
```
    Returns a new Sort.Order with the same configuration as this Sort.Order, but the given path.
    
    Parameters:
    
    path - The path
    
    Returns:
    
    A new Sort.Order with the same configuration as this Sort.Order, but the given path
  - ignoreCase
```
public Sort.Order ignoreCase()
```
    Returns a new Sort.Order with case insensitive sorting enabled.
    
    Returns:
    
    A new Sort.Order with case insensitive sorting enabled
  - with
```
public Sort.Order with(Sort.NullHandling nullHandling)
```
    Returns a new Sort.Order with the given Sort.NullHandling.
    
    Parameters:
    
    nullHandling - The Sort.NullHandling to use, defaults to Sort.NullHandling.NATIVE if null
    
    Returns:
    
    A new Sort.Order with the given Sort.NullHandling
  - nullsFirst
```
public Sort.Order nullsFirst()
```
    Returns a new Sort.Order with Sort.NullHandling.NULLS_FIRST as null handling.
    
    Returns:
    
    A new Sort.Order with Sort.NullHandling.NULLS_FIRST as null handling
  - nullsLast
```
public Sort.Order nullsLast()
```
    Returns a new Sort.Order with Sort.NullHandling.NULLS_LAST as null handling.
    
    Returns:
    
    A new Sort.Order with Sort.NullHandling.NULLS_LAST as null handling
  - nullsNative
```
public Sort.Order nullsNative()
```
    Returns a new Sort.Order with Sort.NullHandling.NATIVE as null handling.
    
    Returns:
    
    A new Sort.Order with Sort.NullHandling.NATIVE as null handling
  - getNullHandling
```
public Sort.NullHandling getNullHandling()
```
    Returns the Sort.NullHandling.
    
    Returns:
    
    The Sort.NullHandling
  - appendTo
```
public void appendTo(java.lang.StringBuilder sb)
```
    Appends the string representation to the given StringBuilder.
    
    Parameters:
    
    sb - The StringBuilder to append to
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Sort.Order

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Order

Order

Order

Method Detail

getDirection

getPath

isAscending

isDescending

isIgnoreCase

with

withPath

ignoreCase

with

nullsFirst

nullsLast

nullsNative

getNullHandling

appendTo

hashCode

equals

toString