jakarta.nosql.mapping

Interface Sorts

public interface Sorts

This instance represents a group of one or more Sort instances. It is useful to either define or append sort from a field at a Repository within a parameter to query by a method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Sorts.SortsProvider A provider class of Sorts

Method Summary

Modifier and Type	Method and Description
Sorts	add(Sort sort) Appends a Sort instance
Sorts	asc(String name) Appends a Sort instance of SortType.ASC from the name
Sorts	desc(String name) Appends a Sort instance of SortType.DESC from the name
List<Sort>	getSorts()
Sorts	remove(Sort sort) Removes a Sort at Sorts
static Sorts	sorts() Creates a new instance of Sorts

Method Detail

asc

Sorts asc(String name)

Appends a Sort instance of SortType.ASC from the name

Parameters:

name - the name

Returns:

a Sorts instance

Throws:

NullPointerException - when name is not null

desc

Sorts desc(String name)

Appends a Sort instance of SortType.DESC from the name

Parameters:

name - the name

Returns:

a Sorts instance

Throws:

NullPointerException - when name is not null

add

Sorts add(Sort sort)

Appends a Sort instance

Parameters:

sort - the sort

Returns:

a Sorts instance

Throws:

NullPointerException - when sort is null

remove

Sorts remove(Sort sort)

Removes a Sort at Sorts

Parameters:

sort - the sort to be removed

Returns:

a Sorts instance

Throws:

NullPointerException - when sort is null

getSorts

List<Sort> getSorts()

Returns:

a list of Sort within in Sorts

sorts

static Sorts sorts()

Creates a new instance of Sorts

Returns:

a Sorts instance