-
Notifications
You must be signed in to change notification settings - Fork 1k
/
AnnotationValueResolver.java
276 lines (244 loc) · 7.5 KB
/
AnnotationValueResolver.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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/*
* Copyright 2017-2020 original authors
*
* 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
*
* https://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.micronaut.core.annotation;
import io.micronaut.core.value.ValueResolver;
import java.util.*;
/**
* Interface for types that resolve annotation values.
*
* @author graemerocher
* @since 1.0.3
*/
public interface AnnotationValueResolver extends ValueResolver<CharSequence> {
/**
* Return the enum value of the given member of the given enum type.
*
* @param member The annotation member
* @param enumType The required type
* @return An {@link Optional} of the enum value
* @param <E> The enum type
*/
<E extends Enum> Optional<E> enumValue(@NonNull String member, @NonNull Class<E> enumType);
/**
* Return the enum value of the given member of the given enum type.
*
* @param enumType The required type
* @return An {@link Optional} of the enum value
* @param <E> The enum type
*/
default <E extends Enum> Optional<E> enumValue(@NonNull Class<E> enumType) {
return enumValue(AnnotationMetadata.VALUE_MEMBER, enumType);
}
/**
* Return the enum value of the given member of the given enum type.
*
* @param member The annotation member
* @param enumType The required type
* @return An {@link Optional} of the enum value
* @param <E> The enum type
*/
<E extends Enum> E[] enumValues(@NonNull String member, @NonNull Class<E> enumType);
/**
* Return the enum value of the given member of the given enum type.
*
* @param enumType The required type
* @return An {@link Optional} of the enum value
* @param <E> The enum type
*/
default <E extends Enum> E[] enumValues(@NonNull Class<E> enumType) {
return enumValues(AnnotationMetadata.VALUE_MEMBER, enumType);
}
/**
* The value of the annotation as a Class.
*
* @return An {@link Optional} class
*/
default Optional<Class<?>> classValue() {
return classValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The value of the given annotation member as a Class.
*
* @param member The annotation member
* @return An {@link Optional} class
*/
Optional<Class<?>> classValue(@NonNull String member);
/**
* The value of the annotation as a Class.
*
* @return An array of classes
*/
@NonNull
default Class<?>[] classValues() {
return classValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The value of the given annotation member as a Class.
*
* @param member The annotation member
* @return An array of classes
*/
@NonNull Class<?>[] classValues(@NonNull String member);
/**
* The {@link AnnotationClassValue} instances for the given member. Unlike {@link #classValues(String)} this may
* include classes that are no the classpath.
*
* @param member The annotation member
* @return An array of class values
*/
@NonNull AnnotationClassValue<?>[] annotationClassValues(@NonNull String member);
/**
* The {@link AnnotationClassValue} instance for the given member.
*
* @param member The annotation member
* @return An annotation class value
*/
Optional<AnnotationClassValue<?>> annotationClassValue(@NonNull String member);
/**
* The integer value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalInt}
*/
OptionalInt intValue(@NonNull String member);
/**
* The integer value of the given member.
*
* @return An {@link OptionalInt}
*/
default OptionalInt intValue() {
return intValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The long value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalLong}
*/
OptionalLong longValue(@NonNull String member);
/**
* The integer value of the given member.
*
* @return An {@link OptionalLong}
*/
default OptionalLong longValue() {
return longValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The double value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalDouble}
*/
OptionalDouble doubleValue(@NonNull String member);
/**
* The double value of the given member.
*
* @return An {@link OptionalDouble}
*/
default OptionalDouble doubleValue() {
return doubleValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The string value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalInt}
*/
Optional<String> stringValue(@NonNull String member);
/**
* The string value of the given member.
*
* @return An {@link OptionalInt}
*/
default Optional<String> stringValue() {
return stringValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The boolean value of the given member.
*
* @param member The annotation member
* @return An {@link Optional} boolean
*/
Optional<Boolean> booleanValue(@NonNull String member);
/**
* The Boolean value of the given member.
*
* @return An {@link Optional} boolean
*/
default Optional<Boolean> booleanValue() {
return booleanValue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* The string value of the given member.
*
* @param member The annotation member
* @return An {@link OptionalInt}
*/
@NonNull String[] stringValues(@NonNull String member);
/**
* The double value of the given member.
*
* @return An {@link OptionalInt}
*/
default @NonNull String[] stringValues() {
return stringValues(AnnotationMetadata.VALUE_MEMBER);
}
/**
* Is the given member present.
* @param member The member
* @return True if it is
*/
boolean isPresent(CharSequence member);
/**
* @return Is the value of the annotation true.
*/
default boolean isTrue() {
return isTrue(AnnotationMetadata.VALUE_MEMBER);
}
/**
* @param member The member
*
* @return Is the value of the annotation true.
*/
boolean isTrue(String member);
/**
* @return Is the value of the annotation true.
*/
default boolean isFalse() {
return isFalse(AnnotationMetadata.VALUE_MEMBER);
}
/**
* @param member The member
*
* @return Is the value of the annotation true.
*/
boolean isFalse(String member);
/**
* The value of the given annotation member as a Class.
*
* @param member The annotation member
* @param requiredType The required type
* @return An {@link Optional} class
* @param <T> The required type
*/
<T> Optional<Class<? extends T>> classValue(@NonNull String member, @NonNull Class<T> requiredType);
/**
* @return The attribute values
*/
@NonNull
Map<CharSequence, Object> getValues();
}