-
Notifications
You must be signed in to change notification settings - Fork 25
/
Sorts.java
93 lines (80 loc) · 2.6 KB
/
Sorts.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
90
91
92
93
/*
* 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.mapping;
import jakarta.nosql.ServiceLoaderProvider;
import jakarta.nosql.Sort;
import java.util.List;
import java.util.ServiceLoader;
import java.util.function.Supplier;
/**
* This instance represents a group of one or more {@link jakarta.nosql.Sort} instances.
* It is useful to either define or append sort from a field at a {@link Repository} within a parameter to query by a method.
*/
public interface Sorts {
/**
* Appends a {@link jakarta.nosql.Sort} instance of {@link jakarta.nosql.SortType#ASC}
* from the name
*
* @param name the name
* @return a {@link Sorts} instance
* @throws NullPointerException when name is not null
*/
Sorts asc(String name);
/**
* Appends a {@link jakarta.nosql.Sort} instance of {@link jakarta.nosql.SortType#DESC}
* from the name
*
* @param name the name
* @return a {@link Sorts} instance
* @throws NullPointerException when name is not null
*/
Sorts desc(String name);
/**
* Appends a {@link Sort} instance
*
* @param sort the sort
* @return a {@link Sorts} instance
* @throws NullPointerException when sort is null
*/
Sorts add(Sort sort);
/**
* Removes a {@link Sort} at {@link Sorts}
*
* @param sort the sort to be removed
* @return a {@link Sorts} instance
* @throws NullPointerException when sort is null
*/
Sorts remove(Sort sort);
/**
* @return a list of {@link Sort} within in {@link Sorts}
*/
List<Sort> getSorts();
/**
* Creates a new instance of {@link Sorts}
*
* @return a {@link Sorts} instance
*/
static Sorts sorts() {
return ServiceLoaderProvider.get(SortsProvider.class,
()-> ServiceLoader.load(SortsProvider.class))
.get();
}
/**
* A provider class of {@link Sorts}
*/
interface SortsProvider extends Supplier<Sorts> {
}
}