Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
Component | 38 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.component.annotation; | |
21 | ||
22 | import java.lang.annotation.Documented; | |
23 | import java.lang.annotation.Retention; | |
24 | import java.lang.annotation.Target; | |
25 | ||
26 | import static java.lang.annotation.ElementType.TYPE; | |
27 | import static java.lang.annotation.RetentionPolicy.RUNTIME; | |
28 | ||
29 | /** | |
30 | * Defines a component implementation. A hint can be specified to differentiate this implementation from another one. | |
31 | * | |
32 | * @version $Id: d29206c04ea407236274e96b2e06cdf54455ee16 $ | |
33 | * @since 1.8.1 | |
34 | */ | |
35 | @Documented | |
36 | @Retention(RUNTIME) | |
37 | @Target(TYPE) | |
38 | public @interface Component | |
39 | { | |
40 | /** | |
41 | * @return the hint value. Can be any text value. It's used to differentiate one component implementation from | |
42 | * another one. | |
43 | * @deprecated since 3.1M1 use the {@code @Named} annotation instead | |
44 | */ | |
45 | @Deprecated | |
46 | String value() default ""; | |
47 | ||
48 | /** | |
49 | * Sometimes you want to register the component several times with different hints. In this case the default | |
50 | * annotation value is ignored and the passed list of hints is used instead. | |
51 | * | |
52 | * @return the list of hints | |
53 | */ | |
54 | String[] hints() default {}; | |
55 | ||
56 | /** | |
57 | * When specified forces the component to be registered as many times as there are roles specified. Otherwise the | |
58 | * superclass/interface hierarchy is scanned for ComponentRole annotations and the component is registered under all | |
59 | * roles found. | |
60 | * | |
61 | * @return the list of roles | |
62 | */ | |
63 | Class<?>[] roles() default {}; | |
64 | ||
65 | /** | |
66 | * @return true if the Component should be registered in a {@code components.txt} file. False can be used for | |
67 | * example when using a component in a test and registering it dynamically without going through a | |
68 | * {@code components.txt} file. | |
69 | */ | |
70 | boolean staticRegistration() default true; | |
71 | } |