View Javadoc

1   /**
2    * This file Copyright (c) 2013 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.module.blossom.annotation;
35  
36  import java.lang.annotation.ElementType;
37  import java.lang.annotation.Retention;
38  import java.lang.annotation.RetentionPolicy;
39  import java.lang.annotation.Target;
40  
41  /**
42   * Denotes an annotation as a component category annotation.
43   *
44   * A component category annotation is used to annotate components as being part of a certain category. The annotation
45   * is then specified in the @AvailableComponentClasses annotation on areas. All components in the category will
46   * then be available in the area.
47   * <p/>
48   * <pre>
49   * &#64;Retention(RetentionPolicy.RUNTIME)
50   * &#64;Target(ElementType.TYPE)
51   * &#64;ComponentCategory
52   * public &#64;interface Promo {
53   * }
54   * </pre>
55   *
56   * @see Template
57   * @see Area
58   * @see AvailableComponentClasses
59   * @since 3.0
60   */
61  @Retention(RetentionPolicy.RUNTIME)
62  @Target(ElementType.ANNOTATION_TYPE)
63  public @interface ComponentCategory {
64  }