Package jakarta.nosql

Interface Sort

public interface Sort

This element represents a required order to be used in a query, it has two attributes: -- The name - the field's name to be sorted -- The type - the way to be sorted

See Also:

of(String, SortType), SortType

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Sort.SortProvider	A provider of Sort where given a String and a SortType it returns a new instance of Sort

Method Summary

Modifier and Type	Method	Description
static Sort	asc(String name)	Creates a new Sort of the type SortType.ASC
static Sort	desc(String name)	Creates a new Sort of the type SortType.DESC
String	getName()	Returns the field name
SortType	getType()	The SortType
static Sort	of(String name, SortType type)	Creates a wew Sort instance to be used in a NoSQL query.

Method Detail

getName

String getName()

Returns the field name

Returns:

the field name

getType

SortType getType()

The SortType

Returns:

The SortType

of

static Sort of(String name,
               SortType type)

Creates a wew Sort instance to be used in a NoSQL query.

Parameters:

name - - the field name be used in a sort process

type - - the way to be sorted

Returns:

a sort instance

Throws:

NullPointerException - when there are null parameters

asc

static Sort asc(String name)

Creates a new Sort of the type SortType.ASC

Parameters:

name - the field name be used in a sort process

Returns:

a sort instance

Throws:

NullPointerException - when name is null

desc

static Sort desc(String name)

Creates a new Sort of the type SortType.DESC

Parameters:

name - the field name be used in a sort process

Returns:

a sort instance

Throws:

NullPointerException - when name is null