1 /**
2 * This file Copyright (c) 2012 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 info.magnolia.rendering.template.AreaDefinition;
37
38 /**
39 * Enumeration of area types.
40 * <ul>
41 * <li><b>NO_COMPONENT</b> The area does not have any components within it</li>
42 * <li><b>LIST</b> The area can have zero or more components within it</li>
43 * <li><b>SINGLE</b> The area can have zero or one component within it</li>
44 * </ul>
45 *
46 * @see Area
47 * @since 2.0
48 */
49 public enum AreaType {
50
51 NO_COMPONENT(AreaDefinition.TYPE_NO_COMPONENT), LIST(AreaDefinition.TYPE_LIST), SINGLE(AreaDefinition.TYPE_SINGLE);
52
53 private final String definitionFormat;
54
55 private AreaType(String definitionFormat) {
56 this.definitionFormat = definitionFormat;
57 }
58
59 public String getDefinitionFormat() {
60 return definitionFormat;
61 }
62 }