Package io.micronaut.data.model

Class Sort.Order

java.lang.Object

io.micronaut.data.model.Sort.Order

Enclosing interface:

Sort

public static class Sort.Order
extends Object

The ordering of results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Sort.Order.Direction	Represents the direction of the ordering.

Constructor Summary

Constructors

Constructor	Description
Order(@NonNull String property)	Constructs an order for the given property in ascending order.
Order(@NonNull String property, @NonNull Sort.Order.Direction direction, boolean ignoreCase)	Constructs an order for the given property with the given direction.

Method Summary

Modifier and Type	Method	Description
static Sort.Order	asc(String property)	Creates a new order for the given property in ascending order.
static Sort.Order	asc(String property, boolean ignoreCase)	Creates a new order for the given property in ascending order.
static Sort.Order	desc(String property)	Creates a new order for the given property in descending order.
static Sort.Order	desc(String property, boolean ignoreCase)	Creates a new order for the given property in descending order.
boolean	equals(Object o)
Sort.Order.Direction	getDirection()
String	getProperty()
int	hashCode()
boolean	isAscending()
boolean	isIgnoreCase()
Sort.Order	reverse()	Create an order that is reversed to current.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Order

public Order(@NonNull
 @NonNull String property)

Constructs an order for the given property in ascending order.

Parameters:

property - The property

Order

@Creator
public Order(@NonNull
 @NonNull String property,
 @NonNull
 @NonNull 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

Method Details

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

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