Module spring.data.commons

Package org.springframework.data.domain

Class Sort.Order

java.lang.Object

org.springframework.data.domain.Sort.Order

All Implemented Interfaces:

Serializable

Enclosing class:

Sort

public static class Sort.Order
extends Object
implements Serializable

PropertyPath implements the pairing of an Sort.Direction and a property. It is used to provide input for Sort

Author:

Oliver Gierke, Kevin Raymond, Jens Schauder

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Order(Sort.Direction direction, String property)	Creates a new Sort.Order instance. if order is null then order defaults to Sort.DEFAULT_DIRECTION
Order(Sort.Direction direction, String property, boolean ignoreCase, Sort.NullHandling nullHandling)	Creates a new Sort.Order instance. if order is null then order defaults to Sort.DEFAULT_DIRECTION
Order(Sort.Direction direction, String property, Sort.NullHandling nullHandlingHint)	Creates a new Sort.Order instance. if order is null then order defaults to Sort.DEFAULT_DIRECTION

Method Summary

Modifier and Type	Method	Description
static Sort.Order	asc(String property)	Creates a new Sort.Order instance.
static Sort.Order	by(String property)	Creates a new Sort.Order instance.
static Sort.Order	desc(String property)	Creates a new Sort.Order instance.
boolean	equals(Object obj)
Sort.Direction	getDirection()	Returns the order the property shall be sorted for.
Sort.NullHandling	getNullHandling()	Returns the used Sort.NullHandling hint, which can but may not be respected by the used datastore.
String	getProperty()	Returns the property to order for.
int	hashCode()
Sort.Order	ignoreCase()	Returns a new Sort.Order with case-insensitive sorting enabled.
boolean	isAscending()	Returns whether sorting for this property shall be ascending.
boolean	isDescending()	Returns whether sorting for this property shall be descending.
boolean	isIgnoreCase()	Returns whether the sort will be case-sensitive or case-insensitive.
Sort.Order	nullsFirst()	Returns a new Sort.Order with Sort.NullHandling.NULLS_FIRST as null handling hint applied.
Sort.Order	nullsLast()	Returns a new Sort.Order with Sort.NullHandling.NULLS_LAST as null handling hint applied.
Sort.Order	nullsNative()	Returns a new Sort.Order with Sort.NullHandling.NATIVE as null handling hint applied.
Sort.Order	reverse()	Returns a new Sort.Order with the reversed getDirection() applied.
String	toString()
Sort.Order	with(Sort.Direction direction)	Returns a new Sort.Order with the given Sort.Direction applied.
Sort.Order	with(Sort.NullHandling nullHandling)	Returns a Sort.Order with the given Sort.NullHandling applied.
Sort	withProperties(String... properties)	Returns a new Sort instance for the given properties using getDirection().
Sort.Order	withProperty(String property)	Returns a new Sort.Order with the property name applied.

Methods inherited from class java.lang.Object

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

Constructor Details

Order

public Order(@Nullable
 Sort.Direction direction,
 String property)

Creates a new Sort.Order instance. if order is null then order defaults to Sort.DEFAULT_DIRECTION

Parameters:

direction - can be null, will default to Sort.DEFAULT_DIRECTION

property - must not be null or empty.

Order

public Order(@Nullable
 Sort.Direction direction,
 String property,
 Sort.NullHandling nullHandlingHint)

Creates a new Sort.Order instance. if order is null then order defaults to Sort.DEFAULT_DIRECTION

Parameters:

direction - can be null, will default to Sort.DEFAULT_DIRECTION

property - must not be null or empty.

nullHandlingHint - must not be null.

Order

public Order(@Nullable
 Sort.Direction direction,
 String property,
 boolean ignoreCase,
 Sort.NullHandling nullHandling)

Creates a new Sort.Order instance. if order is null then order defaults to Sort.DEFAULT_DIRECTION

Parameters:

direction - can be null, will default to Sort.DEFAULT_DIRECTION

property - must not be null or empty.

ignoreCase - true if sorting should be case-insensitive. false if sorting should be case-sensitive.

nullHandling - must not be null.

Since:

1.7

Method Details

by

public static Sort.Order by(String property)

Creates a new Sort.Order instance. Takes a single property. Direction defaults to Sort.DEFAULT_DIRECTION.

Parameters:

property - must not be null or empty.

Since:

2.0

asc

public static Sort.Order asc(String property)

Creates a new Sort.Order instance. Takes a single property. Direction is Sort.Direction.ASC and NullHandling Sort.NullHandling.NATIVE.

Parameters:

property - must not be null or empty.

Since:

2.0

desc

public static Sort.Order desc(String property)

Creates a new Sort.Order instance. Takes a single property. Direction is Sort.Direction.DESC and NullHandling Sort.NullHandling.NATIVE.

Parameters:

property - must not be null or empty.

Since:

2.0

getDirection

public Sort.Direction getDirection()

Returns the order the property shall be sorted for.

Returns:

the order the property shall be sorted for.

getProperty

public String getProperty()

Returns the property to order for.

Returns:

the property to order for.

isAscending

public boolean isAscending()

Returns whether sorting for this property shall be ascending.

Returns:

true if ascending, false otherwise.

isDescending

public boolean isDescending()

Returns whether sorting for this property shall be descending.

Returns:

true if descending, false otherwise.

Since:

1.13

isIgnoreCase

public boolean isIgnoreCase()

Returns whether the sort will be case-sensitive or case-insensitive.

Returns:

true if the sort will be case-sensitive or case-insensitive, false otherwise.

with

public Sort.Order with(Sort.Direction direction)

Returns a new Sort.Order with the given Sort.Direction applied.

Parameters:

direction - the new direction to use.

Returns:

a new Sort.Order with the given Sort.Direction applied.

reverse

public Sort.Order reverse()

Returns a new Sort.Order with the reversed getDirection() applied.

Returns:

a reversed Sort.Order with the given Sort.Direction applied.

Since:

3.1

withProperty

public Sort.Order withProperty(String property)

Returns a new Sort.Order with the property name applied.

Parameters:

property - must not be null or empty.

Returns:

a new Sort.Order with the property name applied.

Since:

1.13

withProperties

public Sort withProperties(String... properties)

Returns a new Sort instance for the given properties using getDirection().

Parameters:

properties - properties to sort by.

Returns:

a new Sort instance for the given properties using getDirection().

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 Sort.Order with the given Sort.NullHandling applied.

Parameters:

nullHandling - can be null.

Returns:

a new Sort.Order with the given Sort.NullHandling applied.

Since:

1.8

nullsFirst

public Sort.Order nullsFirst()

Returns a new Sort.Order with Sort.NullHandling.NULLS_FIRST as null handling hint applied.

Returns:

a new Sort.Order with Sort.NullHandling.NULLS_FIRST as null handling hint applied.

Since:

1.8

nullsLast

public Sort.Order nullsLast()

Returns a new Sort.Order with Sort.NullHandling.NULLS_LAST as null handling hint applied.

Returns:

a new Sort.Order with Sort.NullHandling.NULLS_LAST as null handling hint applied.

Since:

1.7

nullsNative

public Sort.Order nullsNative()

Returns a new Sort.Order with Sort.NullHandling.NATIVE as null handling hint applied.

Returns:

a new Sort.Order with Sort.NullHandling.NATIVE as null handling hint applied.

Since:

1.7

getNullHandling

public Sort.NullHandling getNullHandling()

Returns the used Sort.NullHandling hint, which can but may not be respected by the used datastore.

Returns:

the used Sort.NullHandling hint.

Since:

1.7

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object