Package org.springframework.data.web

Annotation Interface SortDefault

@Documented
@Retention(RUNTIME)
@Target(PARAMETER)
@Repeatable(SortDefaults.class)
public @interface SortDefault

Annotation to define the default Sort options to be used when injecting a Sort instance into a controller handler method.

Since:

1.6

Author:

Oliver Gierke, Mark Palich

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	SortDefault.SortDefaults	Wrapper annotation to allow declaring multiple SortDefault annotations on a method parameter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	caseSensitive	Specifies whether to apply case-sensitive sorting.
Sort.Direction	direction	The direction to sort by.
String[]	sort	The properties to sort by default.
String[]	value	Alias for sort() to make a declaration configuring fields only more concise.

Element Details

value

@AliasFor("sort")
String[] value

Alias for sort() to make a declaration configuring fields only more concise.

Returns:

Default:

{}

sort

@AliasFor("value")
String[] sort

The properties to sort by default. If unset, no sorting will be applied at all.

Returns:

Default:

{}

direction

Sort.Direction direction

The direction to sort by. Defaults to Sort.Direction.ASC.

Returns:

Default:

ASC

caseSensitive

boolean caseSensitive

Specifies whether to apply case-sensitive sorting. Defaults to true.

Returns:

Since:

2.3

Default:

true