-
Notifications
You must be signed in to change notification settings - Fork 25
/
Sort.java
89 lines (78 loc) · 2.54 KB
/
Sort.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
* Copyright (c) 2019 Otavio Santana and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.nosql;
import java.util.ServiceLoader;
import java.util.function.BiFunction;
/**
* 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 Sort#of(String, SortType)
* @see SortType
*/
public interface Sort {
/**
* Returns the field name
*
* @return the field name
*/
String getName();
/**
* The {@link SortType}
*
* @return The {@link SortType}
*/
SortType getType();
/**
* Creates a wew Sort instance to be used in a NoSQL query.
*
* @param name - the field name be used in a sort process
* @param type - the way to be sorted
* @return a sort instance
* @throws NullPointerException when there are null parameters
*/
static Sort of(String name, SortType type) {
return ServiceLoaderProvider.get(SortProvider.class,
() -> ServiceLoader.load(SortProvider.class)).apply(name, type);
}
/**
* Creates a new Sort of the type {@link SortType#ASC}
*
* @param name the field name be used in a sort process
* @return a sort instance
* @throws NullPointerException when name is null
*/
static Sort asc(String name) {
return of(name, SortType.ASC);
}
/**
* Creates a new Sort of the type {@link SortType#DESC}
*
* @param name the field name be used in a sort process
* @return a sort instance
* @throws NullPointerException when name is null
*/
static Sort desc(String name) {
return of(name, SortType.DESC);
}
/**
* A provider of {@link Sort} where given a {@link String} and a {@link SortType}
* it returns a new instance of {@link Sort}
*/
interface SortProvider extends BiFunction<String, SortType, Sort> {
}
}