1 /**
2 * This file Copyright (c) 2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.annotation.deprecation;
35
36 import static java.lang.annotation.ElementType.*;
37
38 import java.lang.annotation.Documented;
39 import java.lang.annotation.Retention;
40 import java.lang.annotation.RetentionPolicy;
41 import java.lang.annotation.Target;
42
43
44 /**
45 * An {@link java.lang.annotation.Annotation annotation} to capture information regarding Deprecated classes and/or methods.
46 *
47 * <p>
48 * This annotation is present in order to provide extra information about the Deprecated classes and therefore
49 * any Deprecated classes should be annotated with {@link Deprecated} annotation explicitly.
50 * </p>
51 * <p>
52 * Usage:
53 * @Deprecated
54 * @MgnlDeprecated(since = "5.6", description = "Was not working properly, replaced by NotDeprecated.class")
55 * class DeprecatedClass {
56 *
57 * @Deprecated
58 * @MgnlDeprecated("5.5")
59 * void deprecatedMethod(){}
60 *
61 * @Deprecated
62 * @MgnlDeprecated(since = "5.5.1", description = "Explaining why it's being deprecated")
63 * void otherDeprecatedMethod(){}
64 * }
65 * </p>
66 */
67 @Documented
68 @Retention(RetentionPolicy.RUNTIME)
69 @Target(value = {METHOD, TYPE})
70 public @interface MgnlDeprecated {
71
72 /**
73 * Defines 'since' which version the particular class and/or method is deprecated.
74 */
75 String since();
76
77 /**
78 * Should be utilised to elaborate the reasoning of deprecation.
79 */
80 String description() default "";
81
82 }