-
Notifications
You must be signed in to change notification settings - Fork 78
/
Stereotype.java
153 lines (148 loc) · 4.46 KB
/
Stereotype.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
/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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 jakarta.enterprise.inject;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* <p>
* Specifies that an annotation type is a stereotype.
* </p>
*
* <p>
* In many systems, use of architectural patterns produces a set of recurring bean roles. A stereotype allows a framework
* developer to identify such a role and declare some common metadata for beans with that role in a central place.
* </p>
*
* <p>
* A bean may declare zero, one or multiple stereotypes, by applying the stereotype annotation to the bean class or producer
* method or field.
* </p>
*
* <p>
* A stereotype encapsulates any combination of:
* </p>
*
* <ul>
* <li>a default scope, and</li>
* <li>a set of interceptor bindings.</li>
* </ul>
*
* <p>
* The default scope of a stereotype is defined by annotating the stereotype with a scope type. A stereotype may declare at most
* one scope. If a bean explicitly declares a scope, any default scopes declared by its stereotypes are ignored.
* </p>
*
* <pre>
* @RequestScoped
* @Stereotype
* @Target(TYPE)
* @Retention(RUNTIME)
* public @interface Action {
* }
* </pre>
*
* <p>
* The interceptor bindings of a stereotype are defined by annotating the stereotype with the interceptor binding types. A
* stereotype may declare zero, one or multiple interceptor bindings. An interceptor binding declared by a stereotype is
* inherited by any bean that declares that stereotype.
* </p>
*
* <pre>
* @RequestScoped
* @Secure
* @Transactional
* @Stereotype
* @Target(TYPE)
* @Retention(RUNTIME)
* public @interface Action {
* }
* </pre>
*
* <p>
* A stereotype may also specify that:
* </p>
*
* <ul>
* <li>all beans with the stereotype have defaulted bean EL names, or that</li>
* <li>all beans with the stereotype are alternatives, or that</li>
* <li>all beans with the stereotype have predefined {@code @Priority}.</li>
* </ul>
*
* <p>
* A stereotype may declare an empty {@link jakarta.inject.Named @Named} annotation, which specifies that every bean with the
* stereotype has a defaulted name when a name is not explicitly specified by the bean.
* </p>
*
* <pre>
* @RequestScoped
* @Named
* @Secure
* @Transactional
* @Stereotype
* @Target(TYPE)
* @Retention(RUNTIME)
* public @interface Action {
* }
* </pre>
*
* <p>
* A stereotype may declare an {@link Alternative @Alternative} annotation, which specifies that
* every bean with the stereotype is an alternative.
* </p>
*
* <pre>
* @Alternative
* @Stereotype
* @Target(TYPE)
* @Retention(RUNTIME)
* public @interface Mock {
* }
* </pre>
*
* <p>
* A stereotype may declare a {@link jakarta.annotation.Priority @Priority} annotation, which specifies that
* every bean with the stereotype has given priority. This enables and orders alternatives, interceptors, and decorators.
* </p>
*
* <pre>
* @Alternative
* @Priority(1)
* @Stereotype
* @Target(TYPE)
* @Retention(RUNTIME)
* public @interface Mock {
* }
* </pre>
*
* <p>
* A stereotype may declare other stereotypes. Stereotype declarations are transitive. A stereotype declared by a second
* stereotype is inherited by all beans and other stereotypes that declare the second stereotype.
* </p>
*
* @see Model the built-in stereotype <code>@Model</code>
*
* @author Pete Muir
* @author Gavin King
*/
@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
@Documented
public @interface Stereotype {
}