Class JpaSort.JpaOrder

java.lang.Object

org.springframework.data.domain.Sort.Order

org.springframework.data.jpa.domain.JpaSort.JpaOrder

All Implemented Interfaces:

Serializable

Enclosing class:

JpaSort

public static class JpaSort.JpaOrder
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.

Author:

Christoph Strobl, Oliver Gierke

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static JpaSort.JpaOrder	asc(String property)	Creates a new JpaOrder instance.
static <T,P> JpaSort.JpaOrder	asc(TypedPropertyPath<T,P> propertyPath)	Creates a new JpaOrder instance.
static JpaSort.JpaOrder	by(String property)	Creates a new JpaOrder instance.
static JpaSort.JpaOrder	desc(String property)	Creates a new JpaOrder instance.
static <T,P> JpaSort.JpaOrder	desc(TypedPropertyPath<T,P> propertyPath)	Creates a new JpaOrder instance.
JpaSort.JpaOrder	ignoreCase()
boolean	isUnsafe()
JpaSort.JpaOrder	with(Sort.Direction order)
JpaSort.JpaOrder	with(Sort.NullHandling nullHandling)
JpaSort	withUnsafe(String... properties)	Creates new JpaSort with potentially unsafe Sort.Order instances.

Methods inherited from class Sort.Order

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

Methods inherited from class Object

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

Method Details

by

public static JpaSort.JpaOrder by(String property)

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

Parameters:

property - must not be null or empty.

Since:

4.1

asc

public static <T,P> JpaSort.JpaOrder asc(TypedPropertyPath<T,P> propertyPath)

Creates a new JpaOrder instance. Takes a property path. Direction is Sort.Direction.ASC and NullHandling Sort.NullHandling.NATIVE.

Parameters:

propertyPath - must not be null or empty.

Since:

4.1

asc

public static JpaSort.JpaOrder asc(String property)

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

Parameters:

property - must not be null or empty.

Since:

4.1

desc

public static <T,P> JpaSort.JpaOrder desc(TypedPropertyPath<T,P> propertyPath)

Creates a new JpaOrder instance. Takes a property path. Direction is Sort.Direction.DESC and NullHandling Sort.NullHandling.NATIVE.

Parameters:

propertyPath - must not be null or empty.

Since:

4.1

desc

public static JpaSort.JpaOrder desc(String property)

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

Parameters:

property - must not be null or empty.

Since:

4.1

with

public JpaSort.JpaOrder with(Sort.Direction order)

Overrides:

with in class Sort.Order

with

public JpaSort.JpaOrder with(Sort.NullHandling nullHandling)

Overrides:

with in class Sort.Order

withUnsafe

@Contract("_ -> new")
@CheckReturnValue
public JpaSort withUnsafe(String... properties)

Creates new JpaSort with potentially unsafe Sort.Order instances.

The returned JpaSort applies the current direction, case-sensitivity, and null-handling settings for all given properties.

Parameters:

properties - must not be null.

Returns:

ignoreCase

public JpaSort.JpaOrder ignoreCase()

Overrides:

ignoreCase in class Sort.Order

isUnsafe

public boolean isUnsafe()

Returns:

true if JpaSort.JpaOrder created withUnsafe(String...).