Debian Codegraph @

api/src/main/java/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilder.java

raw
1 /*
2 * Copyright (c) 2021 Red Hat and others
3 *
4 * This program and the accompanying materials are made available under the
5 * Apache Software License 2.0 which is available at:
6 * https://www.apache.org/licenses/LICENSE-2.0.
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10
11 package jakarta.enterprise.inject.build.compatible.spi;
12
13 import jakarta.enterprise.lang.model.AnnotationInfo;
14 import jakarta.enterprise.lang.model.AnnotationMember;
15 import jakarta.enterprise.lang.model.declarations.ClassInfo;
16 import jakarta.enterprise.lang.model.types.Type;
17
18 import java.lang.annotation.Annotation;
19
20 /**
21 * Builder for annotations of given type.
22 * Expected usage is:
23 * <ol>
24 * <li>create the builder using {@link #of(Class)} or {@link #of(ClassInfo)};</li>
25 * <li>use the {@code value()} and {@code member()} methods to define annotation members;</li>
26 * <li>call {@link #build()} to create an {@link AnnotationInfo}.</li>
27 * </ol>
28 * One builder instance should not be used to create multiple annotations.
29 * <p>
30 * Note that values of all members of given annotation type must be defined before
31 * calling {@code build()}, except of annotation members that declare a default value.
32 * If a value is not defined for an annotation member that does not have a default value,
33 * {@code build()} will throw an exception.
34 * <p>
35 * Defining values of members that do not exist on given annotation type is possible,
36 * and such members will be retained in the resulting {@code AnnotationInfo}. However,
37 * if that {@code AnnotationInfo} is later transformed to an instance of the annotation
38 * type, the non-existing members will disappear.
39 *
40 * @since 4.0
41 */
42 public interface AnnotationBuilder {
43 /**
44 * Returns a new {@link AnnotationBuilder} that builds an annotation of given type.
45 *
46 * @param annotationType the annotation type, must not be {@code null}
47 * @return a new {@code AnnotationBuilder}, never {@code null}
48 */
49 static AnnotationBuilder of(Class<? extends Annotation> annotationType) {
50 return BuildServicesResolver.get().annotationBuilderFactory().create(annotationType);
51 }
52
53 /**
54 * Returns a new {@link AnnotationBuilder} that builds an annotation of given type.
55 *
56 * @param annotationType the annotation type, must not be {@code null}
57 * @return a new {@code AnnotationBuilder}
58 */
59 static AnnotationBuilder of(ClassInfo annotationType) {
60 return BuildServicesResolver.get().annotationBuilderFactory().create(annotationType);
61 }
62
63 /**
64 * Adds an annotation member called {@code value}, whose value is given {@code value}.
65 *
66 * @param value value of the annotation member
67 * @return this {@code AnnotationBuilder}
68 */
69 default AnnotationBuilder value(AnnotationMember value) {
70 return member(AnnotationMember.VALUE, value);
71 }
72
73 /**
74 * Adds a boolean-valued annotation member called {@code value}.
75 *
76 * @param value the boolean value
77 * @return this {@code AnnotationBuilder}
78 */
79 default AnnotationBuilder value(boolean value) {
80 return member(AnnotationMember.VALUE, value);
81 }
82
83 /**
84 * Adds a boolean array-valued annotation member called {@code value}.
85 *
86 * @param values the boolean array, must not be {@code null}
87 * @return this {@code AnnotationBuilder}
88 */
89 default AnnotationBuilder value(boolean[] values) {
90 return member(AnnotationMember.VALUE, values);
91 }
92
93 /**
94 * Adds a byte-valued annotation member called {@code value}.
95 *
96 * @param value the byte value
97 * @return this {@code AnnotationBuilder}
98 */
99 default AnnotationBuilder value(byte value) {
100 return member(AnnotationMember.VALUE, value);
101 }
102
103 /**
104 * Adds a byte array-valued annotation member called {@code value}.
105 *
106 * @param values the byte array, must not be {@code null}
107 * @return this {@code AnnotationBuilder}
108 */
109 default AnnotationBuilder value(byte[] values) {
110 return member(AnnotationMember.VALUE, values);
111 }
112
113 /**
114 * Adds a short-valued annotation member called {@code value}.
115 *
116 * @param value the short value
117 * @return this {@code AnnotationBuilder}
118 */
119 default AnnotationBuilder value(short value) {
120 return member(AnnotationMember.VALUE, value);
121 }
122
123 /**
124 * Adds a short array-valued annotation member called {@code value}.
125 *
126 * @param values the short array, must not be {@code null}
127 * @return this {@code AnnotationBuilder}
128 */
129 default AnnotationBuilder value(short[] values) {
130 return member(AnnotationMember.VALUE, values);
131 }
132
133 /**
134 * Adds an int-valued annotation member called {@code value}.
135 *
136 * @param value the int value
137 * @return this {@code AnnotationBuilder}
138 */
139 default AnnotationBuilder value(int value) {
140 return member(AnnotationMember.VALUE, value);
141 }
142
143 /**
144 * Adds an int array-valued annotation member called {@code value}.
145 *
146 * @param values the int array, must not be {@code null}
147 * @return this {@code AnnotationBuilder}
148 */
149 default AnnotationBuilder value(int[] values) {
150 return member(AnnotationMember.VALUE, values);
151 }
152
153 /**
154 * Adds a long-valued annotation member called {@code value}.
155 *
156 * @param value the long value
157 * @return this {@code AnnotationBuilder}
158 */
159 default AnnotationBuilder value(long value) {
160 return member(AnnotationMember.VALUE, value);
161 }
162
163 /**
164 * Adds a long array-valued annotation member called {@code value}.
165 *
166 * @param values the long array, must not be {@code null}
167 * @return this {@code AnnotationBuilder}
168 */
169 default AnnotationBuilder value(long[] values) {
170 return member(AnnotationMember.VALUE, values);
171 }
172
173 /**
174 * Adds a float-valued annotation member called {@code value}.
175 *
176 * @param value the float value
177 * @return this {@code AnnotationBuilder}
178 */
179 default AnnotationBuilder value(float value) {
180 return member(AnnotationMember.VALUE, value);
181 }
182
183 /**
184 * Adds a float array-valued annotation member called {@code value}.
185 *
186 * @param values the float array, must not be {@code null}
187 * @return this {@code AnnotationBuilder}
188 */
189 default AnnotationBuilder value(float[] values) {
190 return member(AnnotationMember.VALUE, values);
191 }
192
193 /**
194 * Adds a double-valued annotation member called {@code value}.
195 *
196 * @param value the double value
197 * @return this {@code AnnotationBuilder}
198 */
199 default AnnotationBuilder value(double value) {
200 return member(AnnotationMember.VALUE, value);
201 }
202
203 /**
204 * Adds a double array-valued annotation member called {@code value}.
205 *
206 * @param values the double array, must not be {@code null}
207 * @return this {@code AnnotationBuilder}
208 */
209 default AnnotationBuilder value(double[] values) {
210 return member(AnnotationMember.VALUE, values);
211 }
212
213 /**
214 * Adds a char-valued annotation member called {@code value}.
215 *
216 * @param value the char value
217 * @return this {@code AnnotationBuilder}
218 */
219 default AnnotationBuilder value(char value) {
220 return member(AnnotationMember.VALUE, value);
221 }
222
223 /**
224 * Adds a char array-valued annotation member called {@code value}.
225 *
226 * @param values the char array, must not be {@code null}
227 * @return this {@code AnnotationBuilder}
228 */
229 default AnnotationBuilder value(char[] values) {
230 return member(AnnotationMember.VALUE, values);
231 }
232
233 /**
234 * Adds a String-valued annotation member called {@code value}.
235 *
236 * @param value the String value, must not be {@code null}
237 * @return this {@code AnnotationBuilder}
238 */
239 default AnnotationBuilder value(String value) {
240 return member(AnnotationMember.VALUE, value);
241 }
242
243 /**
244 * Adds a String array-valued annotation member called {@code value}.
245 *
246 * @param values the String array, must not be {@code null} or contain {@code null}
247 * @return this {@code AnnotationBuilder}
248 */
249 default AnnotationBuilder value(String[] values) {
250 return member(AnnotationMember.VALUE, values);
251 }
252
253 /**
254 * Adds an enum-valued annotation member called {@code value}.
255 *
256 * @param value the enum value, must not be {@code null}
257 * @return this {@code AnnotationBuilder}
258 */
259 default AnnotationBuilder value(Enum<?> value) {
260 return member(AnnotationMember.VALUE, value);
261 }
262
263 /**
264 * Adds an enum array-valued annotation member called {@code value}.
265 *
266 * @param values the enum array, must not be {@code null} or contain {@code null}
267 * @return this {@code AnnotationBuilder}
268 */
269 default AnnotationBuilder value(Enum<?>[] values) {
270 return member(AnnotationMember.VALUE, values);
271 }
272
273 /**
274 * Adds an enum-valued annotation member called {@code value}.
275 *
276 * @param enumType the enum type, must not be {@code null}
277 * @param enumValue name of the enum constant, must not be {@code null}
278 * @return this {@code AnnotationBuilder}
279 */
280 default AnnotationBuilder value(Class<? extends Enum<?>> enumType, String enumValue) {
281 return member(AnnotationMember.VALUE, enumType, enumValue);
282 }
283
284 /**
285 * Adds an enum array-valued annotation member called {@code value}.
286 *
287 * @param enumType the enum type, must not be {@code null}
288 * @param enumValues names of the enum constants, must not be {@code null} or contain {@code null}
289 * @return this {@code AnnotationBuilder}
290 */
291 default AnnotationBuilder value(Class<? extends Enum<?>> enumType, String[] enumValues) {
292 return member(AnnotationMember.VALUE, enumType, enumValues);
293 }
294
295 /**
296 * Adds an enum-valued annotation member called {@code value}.
297 *
298 * @param enumType the enum type, must not be {@code null}
299 * @param enumValue name of the enum constant, must not be {@code null}
300 * @return this {@code AnnotationBuilder}
301 */
302 default AnnotationBuilder value(ClassInfo enumType, String enumValue) {
303 return member(AnnotationMember.VALUE, enumType, enumValue);
304 }
305
306 /**
307 * Adds an enum array-valued annotation member called {@code value}.
308 *
309 * @param enumType the enum type, must not be {@code null}
310 * @param enumValues names of the enum constants, must not be {@code null} or contain {@code null}
311 * @return this {@code AnnotationBuilder}
312 */
313 default AnnotationBuilder value(ClassInfo enumType, String[] enumValues) {
314 return member(AnnotationMember.VALUE, enumType, enumValues);
315 }
316
317 /**
318 * Adds a class-valued annotation member called {@code value}.
319 *
320 * @param value the class value, must not be {@code null}
321 * @return this {@code AnnotationBuilder}
322 */
323 default AnnotationBuilder value(Class<?> value) {
324 return member(AnnotationMember.VALUE, value);
325 }
326
327 /**
328 * Adds a class array-valued annotation member called {@code value}.
329 *
330 * @param values the class array, must not be {@code null} or contain {@code null}
331 * @return this {@code AnnotationBuilder}
332 */
333 default AnnotationBuilder value(Class<?>[] values) {
334 return member(AnnotationMember.VALUE, values);
335 }
336
337 /**
338 * Adds a class-valued annotation member called {@code value}.
339 *
340 * @param value the class value, must not be {@code null}
341 * @return this {@code AnnotationBuilder}
342 */
343 default AnnotationBuilder value(ClassInfo value) {
344 return member(AnnotationMember.VALUE, value);
345 }
346
347 /**
348 * Adds a class array-valued annotation member called {@code value}.
349 *
350 * @param values the class array, must not be {@code null} or contain {@code null}
351 * @return this {@code AnnotationBuilder}
352 */
353 default AnnotationBuilder value(ClassInfo[] values) {
354 return member(AnnotationMember.VALUE, values);
355 }
356
357 /**
358 * Adds a class-valued annotation member called {@code value}.
359 * The {@code value} parameter may only be:
360 * <ul>
361 * <li>{@link jakarta.enterprise.lang.model.types.VoidType VoidType};</li>
362 * <li>{@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType};</li>
363 * <li>{@link jakarta.enterprise.lang.model.types.ClassType ClassType};</li>
364 * <li>{@link jakarta.enterprise.lang.model.types.ArrayType ArrayType}
365 * whose element type is either {@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType}
366 * or {@link jakarta.enterprise.lang.model.types.ClassType ClassType}.</li>
367 * </ul>
368 *
369 * @param value the class value, must not be {@code null}
370 * @return this {@code AnnotationBuilder}
371 * @throws IllegalArgumentException if given type is invalid, as described above
372 */
373 default AnnotationBuilder value(Type value) {
374 return member(AnnotationMember.VALUE, value);
375 }
376
377 /**
378 * Adds a class array-valued annotation member called {@code value}.
379 * The {@code values} parameter may only contain:
380 * <ul>
381 * <li>{@link jakarta.enterprise.lang.model.types.VoidType VoidType};</li>
382 * <li>{@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType};</li>
383 * <li>{@link jakarta.enterprise.lang.model.types.ClassType ClassType};</li>
384 * <li>{@link jakarta.enterprise.lang.model.types.ArrayType ArrayType}
385 * whose element type is either {@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType}
386 * or {@link jakarta.enterprise.lang.model.types.ClassType ClassType}.</li>
387 * </ul>
388 *
389 * @param values the class array, must not be {@code null} or contain {@code null}
390 * @return this {@code AnnotationBuilder}
391 * @throws IllegalArgumentException if any given type is invalid, as described above
392 */
393 default AnnotationBuilder value(Type[] values) {
394 return member(AnnotationMember.VALUE, values);
395 }
396
397 /**
398 * Adds an annotation-valued annotation member called {@code value}.
399 *
400 * @param value the annotation value, must not be {@code null}
401 * @return this {@code AnnotationBuilder}
402 */
403 default AnnotationBuilder value(AnnotationInfo value) {
404 return member(AnnotationMember.VALUE, value);
405 }
406
407 /**
408 * Adds an annotation array-valued annotation member called {@code value}.
409 *
410 * @param values the annotation array, must not be {@code null} or contain {@code null}
411 * @return this {@code AnnotationBuilder}
412 */
413 default AnnotationBuilder value(AnnotationInfo[] values) {
414 return member(AnnotationMember.VALUE, values);
415 }
416
417 /**
418 * Adds an annotation-valued annotation member called {@code value}.
419 *
420 * @param value the annotation value, must not be {@code null}
421 * @return this {@code AnnotationBuilder}
422 */
423 default AnnotationBuilder value(Annotation value) {
424 return member(AnnotationMember.VALUE, value);
425 }
426
427 /**
428 * Adds an annotation array-valued annotation member called {@code value}.
429 *
430 * @param values the annotation array, must not be {@code null} or contain {@code null}
431 * @return this {@code AnnotationBuilder}
432 */
433 default AnnotationBuilder value(Annotation[] values) {
434 return member(AnnotationMember.VALUE, values);
435 }
436
437 /**
438 * Adds an annotation member with given {@code name}, whose value is given {@code value}.
439 *
440 * @param name name of the annotation member, must not be {@code null}
441 * @param value value of the annotation member, must not be {@code null}
442 * @return this {@code AnnotationBuilder}
443 */
444 AnnotationBuilder member(String name, AnnotationMember value);
445
446 /**
447 * Adds a boolean-valued annotation member with given {@code name}.
448 *
449 * @param name the member name, must not be {@code null}
450 * @param value the boolean value
451 * @return this {@code AnnotationBuilder}
452 */
453 AnnotationBuilder member(String name, boolean value);
454
455 /**
456 * Adds a boolean array-valued annotation member with given {@code name}.
457 *
458 * @param name the member name, must not be {@code null}
459 * @param values the boolean array, must not be {@code null}
460 * @return this {@code AnnotationBuilder}
461 */
462 AnnotationBuilder member(String name, boolean[] values);
463
464 /**
465 * Adds a byte-valued annotation member with given {@code name}.
466 *
467 * @param name the member name, must not be {@code null}
468 * @param value the byte value
469 * @return this {@code AnnotationBuilder}
470 */
471 AnnotationBuilder member(String name, byte value);
472
473 /**
474 * Adds a byte array-valued annotation member with given {@code name}.
475 *
476 * @param name the member name, must not be {@code null}
477 * @param values the byte array, must not be {@code null}
478 * @return this {@code AnnotationBuilder}
479 */
480 AnnotationBuilder member(String name, byte[] values);
481
482 /**
483 * Adds a short-valued annotation member with given {@code name}.
484 *
485 * @param name the member name, must not be {@code null}
486 * @param value the short value
487 * @return this {@code AnnotationBuilder}
488 */
489 AnnotationBuilder member(String name, short value);
490
491 /**
492 * Adds a short array-valued annotation member with given {@code name}.
493 *
494 * @param name the member name, must not be {@code null}
495 * @param values the short array, must not be {@code null}
496 * @return this {@code AnnotationBuilder}
497 */
498 AnnotationBuilder member(String name, short[] values);
499
500 /**
501 * Adds an int-valued annotation member with given {@code name}.
502 *
503 * @param name the member name, must not be {@code null}
504 * @param value the int value
505 * @return this {@code AnnotationBuilder}
506 */
507 AnnotationBuilder member(String name, int value);
508
509 /**
510 * Adds an int array-valued annotation member with given {@code name}.
511 *
512 * @param name the member name, must not be {@code null}
513 * @param values the int array, must not be {@code null}
514 * @return this {@code AnnotationBuilder}
515 */
516 AnnotationBuilder member(String name, int[] values);
517
518 /**
519 * Adds a long-valued annotation member with given {@code name}.
520 *
521 * @param name the member name, must not be {@code null}
522 * @param value the long value
523 * @return this {@code AnnotationBuilder}
524 */
525 AnnotationBuilder member(String name, long value);
526
527 /**
528 * Adds a long array-valued annotation member with given {@code name}.
529 *
530 * @param name the member name, must not be {@code null}
531 * @param values the long array, must not be {@code null}
532 * @return this {@code AnnotationBuilder}
533 */
534 AnnotationBuilder member(String name, long[] values);
535
536 /**
537 * Adds a float-valued annotation member with given {@code name}.
538 *
539 * @param name the member name, must not be {@code null}
540 * @param value the float value
541 * @return this {@code AnnotationBuilder}
542 */
543 AnnotationBuilder member(String name, float value);
544
545 /**
546 * Adds a float array-valued annotation member with given {@code name}.
547 *
548 * @param name the member name, must not be {@code null}
549 * @param values the float array, must not be {@code null}
550 * @return this {@code AnnotationBuilder}
551 */
552 AnnotationBuilder member(String name, float[] values);
553
554 /**
555 * Adds a double-valued annotation member with given {@code name}.
556 *
557 * @param name the member name, must not be {@code null}
558 * @param value the double value
559 * @return this {@code AnnotationBuilder}
560 */
561 AnnotationBuilder member(String name, double value);
562
563 /**
564 * Adds a double array-valued annotation member with given {@code name}.
565 *
566 * @param name the member name, must not be {@code null}
567 * @param values the double array, must not be {@code null}
568 * @return this {@code AnnotationBuilder}
569 */
570 AnnotationBuilder member(String name, double[] values);
571
572 /**
573 * Adds a char-valued annotation member with given {@code name}.
574 *
575 * @param name the member name, must not be {@code null}
576 * @param value the char value
577 * @return this {@code AnnotationBuilder}
578 */
579 AnnotationBuilder member(String name, char value);
580
581 /**
582 * Adds a char array-valued annotation member with given {@code name}.
583 *
584 * @param name the member name, must not be {@code null}
585 * @param values the char array, must not be {@code null}
586 * @return this {@code AnnotationBuilder}
587 */
588 AnnotationBuilder member(String name, char[] values);
589
590 /**
591 * Adds a String-valued annotation member with given {@code name}.
592 *
593 * @param name the member name, must not be {@code null}
594 * @param value the String value, must not be {@code null}
595 * @return this {@code AnnotationBuilder}
596 */
597 AnnotationBuilder member(String name, String value);
598
599 /**
600 * Adds a String array-valued annotation member with given {@code name}.
601 *
602 * @param name the member name, must not be {@code null}
603 * @param values the String array, must not be {@code null} or contain {@code null}
604 * @return this {@code AnnotationBuilder}
605 */
606 AnnotationBuilder member(String name, String[] values);
607
608 /**
609 * Adds an enum-valued annotation member with given {@code name}.
610 *
611 * @param name the member name, must not be {@code null}
612 * @param value the enum value, must not be {@code null}
613 * @return this {@code AnnotationBuilder}
614 */
615 AnnotationBuilder member(String name, Enum<?> value);
616
617 /**
618 * Adds an enum array-valued annotation member with given {@code name}.
619 *
620 * @param name the member name, must not be {@code null}
621 * @param values the enum array, must not be {@code null} or contain {@code null}
622 * @return this {@code AnnotationBuilder}
623 */
624 AnnotationBuilder member(String name, Enum<?>[] values);
625
626 /**
627 * Adds an enum-valued annotation member with given {@code name}.
628 *
629 * @param name the member name, must not be {@code null}
630 * @param enumType the enum type, must not be {@code null}
631 * @param enumValue name of the enum constant, must not be {@code null}
632 * @return this {@code AnnotationBuilder}
633 */
634 AnnotationBuilder member(String name, Class<? extends Enum<?>> enumType, String enumValue);
635
636 /**
637 * Adds an enum array-valued annotation member with given {@code name}.
638 *
639 * @param name the member name, must not be {@code null}
640 * @param enumType the enum type, must not be {@code null}
641 * @param enumValues names of the enum constants, must not be {@code null} or contain {@code null}
642 * @return this {@code AnnotationBuilder}
643 */
644 AnnotationBuilder member(String name, Class<? extends Enum<?>> enumType, String[] enumValues);
645
646 /**
647 * Adds an enum-valued annotation member with given {@code name}.
648 *
649 * @param name the member name, must not be {@code null}
650 * @param enumType the enum type, must not be {@code null}
651 * @param enumValue name of the enum constant, must not be {@code null}
652 * @return this {@code AnnotationBuilder}
653 */
654 AnnotationBuilder member(String name, ClassInfo enumType, String enumValue);
655
656 /**
657 * Adds an enum array-valued annotation member with given {@code name}.
658 *
659 * @param name the member name, must not be {@code null}
660 * @param enumType the enum type, must not be {@code null}
661 * @param enumValues names of the enum constants, must not be {@code null} or contain {@code null}
662 * @return this {@code AnnotationBuilder}
663 */
664 AnnotationBuilder member(String name, ClassInfo enumType, String[] enumValues);
665
666 /**
667 * Adds a class-valued annotation member with given {@code name}.
668 *
669 * @param name the member name, must not be {@code null}
670 * @param value the class value, must not be {@code null}
671 * @return this {@code AnnotationBuilder}
672 */
673 AnnotationBuilder member(String name, Class<?> value);
674
675 /**
676 * Adds a class array-valued annotation member with given {@code name}.
677 *
678 * @param name the member name, must not be {@code null}
679 * @param values the class array, must not be {@code null} or contain {@code null}
680 * @return this {@code AnnotationBuilder}
681 */
682 AnnotationBuilder member(String name, Class<?>[] values);
683
684 /**
685 * Adds a class-valued annotation member with given {@code name}.
686 *
687 * @param name the member name, must not be {@code null}
688 * @param value the class value, must not be {@code null}
689 * @return this {@code AnnotationBuilder}
690 */
691 AnnotationBuilder member(String name, ClassInfo value);
692
693 /**
694 * Adds a class array-valued annotation member with given {@code name}.
695 *
696 * @param name the member name, must not be {@code null}
697 * @param values the class array, must not be {@code null} or contain {@code null}
698 * @return this {@code AnnotationBuilder}
699 */
700 AnnotationBuilder member(String name, ClassInfo[] values);
701
702 /**
703 * Adds a class-valued annotation member with given {@code name}.
704 * The {@code value} parameter may only be:
705 * <ul>
706 * <li>{@link jakarta.enterprise.lang.model.types.VoidType VoidType};</li>
707 * <li>{@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType};</li>
708 * <li>{@link jakarta.enterprise.lang.model.types.ClassType ClassType};</li>
709 * <li>{@link jakarta.enterprise.lang.model.types.ArrayType ArrayType}
710 * whose element type is either {@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType}
711 * or {@link jakarta.enterprise.lang.model.types.ClassType ClassType}.</li>
712 * </ul>
713 * Any other value results in an exception.
714 *
715 * @param name the member name, must not be {@code null}
716 * @param value the class value, must not be {@code null}
717 * @return this {@code AnnotationBuilder}
718 * @throws IllegalArgumentException if given type is invalid, as described above
719 */
720 AnnotationBuilder member(String name, Type value);
721
722 /**
723 * Adds a class array-valued annotation member with given {@code name}.
724 * The {@code values} parameter may only include:
725 * <ul>
726 * <li>{@link jakarta.enterprise.lang.model.types.VoidType VoidType};</li>
727 * <li>{@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType};</li>
728 * <li>{@link jakarta.enterprise.lang.model.types.ClassType ClassType};</li>
729 * <li>{@link jakarta.enterprise.lang.model.types.ArrayType ArrayType}
730 * whose element type is either {@link jakarta.enterprise.lang.model.types.PrimitiveType PrimitiveType}
731 * or {@link jakarta.enterprise.lang.model.types.ClassType ClassType}.</li>
732 * </ul>
733 *
734 * @param name the member name, must not be {@code null}
735 * @param values the class array, must not be {@code null} or contain {@code null}
736 * @return this {@code AnnotationBuilder}
737 * @throws IllegalArgumentException if any given type is invalid, as described above
738 */
739 AnnotationBuilder member(String name, Type[] values);
740
741 /**
742 * Adds an annotation-valued annotation member with given {@code name}.
743 *
744 * @param name the member name, must not be {@code null}
745 * @param value the annotation value, must not be {@code null}
746 * @return this {@code AnnotationBuilder}
747 */
748 AnnotationBuilder member(String name, AnnotationInfo value);
749
750 /**
751 * Adds an annotation array-valued annotation member with given {@code name}.
752 *
753 * @param name the member name, must not be {@code null}
754 * @param values the annotation array, must not be {@code null} or contain {@code null}
755 * @return this {@code AnnotationBuilder}
756 */
757 AnnotationBuilder member(String name, AnnotationInfo[] values);
758
759 /**
760 * Adds an annotation-valued annotation member with given {@code name}.
761 *
762 * @param name the member name, must not be {@code null}
763 * @param value the annotation value, must not be {@code null}
764 * @return this {@code AnnotationBuilder}
765 */
766 AnnotationBuilder member(String name, Annotation value);
767
768 /**
769 * Adds an annotation array-valued annotation member with given {@code name}.
770 *
771 * @param name the member name, must not be {@code null}
772 * @param values the annotation array, must not be {@code null} or contain {@code null}
773 * @return this {@code AnnotationBuilder}
774 */
775 AnnotationBuilder member(String name, Annotation[] values);
776
777 /**
778 * Returns an {@link AnnotationInfo} that includes all annotation members defined by previous method calls
779 * on this builder. After {@code build()} is called, this builder instance should be discarded.
780 *
781 * @return the built {@link AnnotationInfo}, never {@code null}
782 * @throws IllegalStateException if a value of some annotation member was not set, and that member
783 * does not declare a default value
784 */
785 AnnotationInfo build();
786 }