Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
DisposePriority | 50 | 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.Inherited; | |
24 | import java.lang.annotation.Retention; | |
25 | import java.lang.annotation.Target; | |
26 | ||
27 | import static java.lang.annotation.ElementType.TYPE; | |
28 | import static java.lang.annotation.RetentionPolicy.RUNTIME; | |
29 | ||
30 | /** | |
31 | * <p> | |
32 | * Helps controlling the order in which Components are disposed upon XWiki's shutdown. This annotation is optional | |
33 | * and should be used only for Components needing to be disposed before or after other components (for example | |
34 | * the Database shutdown needs to be executed after all other components using DB storage have been disposed of). | |
35 | * </p> | |
36 | * <p> | |
37 | * When used, this annotation takes precedence over the natural order defined by explicit Component dependencies. | |
38 | * </p> | |
39 | * <p> | |
40 | * The default priority is 1000. | |
41 | * </p> | |
42 | * | |
43 | * @version $Id: 814159c532d3a21bd877007aa7b4c1c6443eed00 $ | |
44 | * @since 6.2.1 | |
45 | */ | |
46 | @Documented | |
47 | @Retention(RUNTIME) | |
48 | @Target(TYPE) | |
49 | @Inherited | |
50 | public @interface DisposePriority | |
51 | { | |
52 | /** | |
53 | * Default dispose priority. | |
54 | */ | |
55 | int DEFAULT_PRIORITY = 1000; | |
56 | ||
57 | /** | |
58 | * @return the priority to use, knowing that the smaller the value the higher the priority. | |
59 | */ | |
60 | int value() default DEFAULT_PRIORITY; | |
61 | } |