Class SqlSort.SqlOrder

java.lang.Object

org.springframework.data.domain.Sort.Order

org.springframework.data.relational.domain.SqlSort.SqlOrder

All Implemented Interfaces:

Serializable

Enclosing class:

SqlSort

public static class SqlSort.SqlOrder
extends Sort.Order

Custom Sort.Order that keeps a flag to indicate unsafe property handling, i.e. the String provided is not necessarily a property but can be an arbitrary expression piped into the query execution. We also keep an additional ignoreCase flag around as the constructor of the superclass is private currently.

Since:

3.1

Author:

Christoph Strobl, Oliver Gierke

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static SqlSort.SqlOrder	asc(String property)	Creates a new SqlSort.SqlOrder instance.
static SqlSort.SqlOrder	by(String property)	Creates a new SqlSort.SqlOrder instance.
static SqlSort.SqlOrder	desc(String property)	Creates a new SqlSort.SqlOrder instance.
SqlSort.SqlOrder	ignoreCase()
boolean	isUnsafe()
SqlSort.SqlOrder	with(Sort.Direction order)
SqlSort.SqlOrder	with(Sort.NullHandling nullHandling)
SqlSort.SqlOrder	withUnsafe()

Methods inherited from class Sort.Order

equals, getDirection, getNullHandling, getProperty, hashCode, isAscending, isDescending, isIgnoreCase, nullsFirst, nullsLast, nullsNative, reverse, toString, withProperties, withProperty

Methods inherited from class Object

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

Method Details

by

public static SqlSort.SqlOrder by(String property)

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

Parameters:

property - must not be null or empty.

asc

public static SqlSort.SqlOrder asc(String property)

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

Parameters:

property - must not be null or empty.

desc

public static SqlSort.SqlOrder desc(String property)

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

Parameters:

property - must not be null or empty.

with

public SqlSort.SqlOrder with(Sort.Direction order)

Overrides:

with in class Sort.Order

with

public SqlSort.SqlOrder with(Sort.NullHandling nullHandling)

Overrides:

with in class Sort.Order

withUnsafe

public SqlSort.SqlOrder withUnsafe()

ignoreCase

public SqlSort.SqlOrder ignoreCase()

Overrides:

ignoreCase in class Sort.Order

isUnsafe

public boolean isUnsafe()

Returns:

true if SqlSort.SqlOrder should not be validated automatically. The validation should be done by the developer using this.