/
Find.java
131 lines (121 loc) · 4 KB
/
Find.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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
* Copyright (c) 2020. https://rxmicro.io
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.rxmicro.data.mongo.operation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static io.rxmicro.common.CommonConstants.EMPTY_STRING;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.CLASS;
/**
* Denotes a repository method that must execute a
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.find/">{@code db.collection.find()}</a> operation.
*
* @author nedis
* @see io.rxmicro.data.mongo.MongoRepository
* @see Aggregate
* @see CountDocuments
* @see Delete
* @see Distinct
* @see EstimatedDocumentCount
* @see Insert
* @see Update
* @since 0.1
*/
@Documented
@Retention(CLASS)
@Target(METHOD)
public @interface Find {
/**
* Returns the selection filter using query operators.
*
* <p>
* Read more:
* <a href="https://docs.mongodb.com/manual/reference/operator/">
* https://docs.mongodb.com/manual/reference/operator/
* </a>
*
* @return the selection filter using query operators.
*/
String query() default EMPTY_STRING;
/**
* Returns the query projection.
*
* <p>
* Read more:
*
* <p>
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.find/#projection">
* https://docs.mongodb.com/manual/reference/method/db.collection.find/#projection
* </a>
*
* <p>
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.find/#projections">
* https://docs.mongodb.com/manual/reference/method/db.collection.find/#projections
* </a>
*
* @return the query projection
*/
String projection() default EMPTY_STRING;
/**
* Returns the index to use for the find operation.
*
* <p>
* Read more:
* <a href="https://docs.mongodb.com/manual/reference/method/cursor.hint/#cursor.hint">
* https://docs.mongodb.com/manual/reference/method/cursor.hint/#cursor.hint
* </a>
*
* @return the index to use for the find operation
*/
String hint() default EMPTY_STRING;
/**
* Returns the sort expression.
*
* <p>
* Read more:
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.find/#order-documents-in-the-result-set">
* https://docs.mongodb.com/manual/reference/method/db.collection.find/#order-documents-in-the-result-set
* </a>
*
* @return the sort expression
*/
String sort() default EMPTY_STRING;
/**
* Returns the limit of the result set.
*
* <p>
* Read more:
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.find/#limit-the-number-of-documents-to-return">
* https://docs.mongodb.com/manual/reference/method/db.collection.find/#limit-the-number-of-documents-to-return
* </a>
*
* @return the limit of the result set
*/
int limit() default -1;
/**
* Returns the start point of the result set.
*
* <p>
* Read more:
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.find/#set-the-starting-point-of-the-result-set">
* https://docs.mongodb.com/manual/reference/method/db.collection.find/#set-the-starting-point-of-the-result-set
* </a>
*
* @return the start point of the result set
*/
int skip() default -1;
}