View Javadoc

1   /**
2    * This file Copyright (c) 2012-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.template;
35  
36  import java.lang.annotation.Annotation;
37  import java.util.ArrayList;
38  import java.util.HashMap;
39  import java.util.List;
40  import java.util.Map;
41  
42  import org.springframework.util.LinkedMultiValueMap;
43  import org.springframework.util.MultiValueMap;
44  
45  /**
46   * Holds meta data built while detecting handlers.
47   *
48   * @see HandlerMetaData
49   * @see TemplateExporter
50   * @since 2.0
51   */
52  public class DetectedHandlersMetaData {
53  
54      private List<HandlerMetaData> templates = new ArrayList<HandlerMetaData>();
55      private Map<Class<?>, List<HandlerMetaData>> areasByEnclosingClass = new HashMap<Class<?>, List<HandlerMetaData>>();
56      private MultiValueMap<Class<? extends Annotation>, String> categoryUsages = new LinkedMultiValueMap<Class<? extends Annotation>, String>();
57  
58      public void addTemplate(HandlerMetaData handlerMetaData) {
59          this.templates.add(handlerMetaData);
60      }
61  
62      public List<HandlerMetaData> getTemplates() {
63          return templates;
64      }
65  
66      public void addArea(HandlerMetaData handler) {
67          Class<?> enclosingClass = handler.getHandlerClass().getEnclosingClass();
68          List<HandlerMetaData> list = areasByEnclosingClass.get(enclosingClass);
69          if (list == null) {
70              list = new ArrayList<HandlerMetaData>();
71              areasByEnclosingClass.put(enclosingClass, list);
72          }
73          list.add(handler);
74      }
75  
76      public List<HandlerMetaData> getAreasByEnclosingClass(Class<?> enclosingClass) {
77          return areasByEnclosingClass.get(enclosingClass);
78      }
79  
80      public void addCategories(String templateId, List<Class<? extends Annotation>> categories) {
81          for (Class<? extends Annotation> category : categories) {
82              categoryUsages.add(category, templateId);
83          }
84      }
85  
86      public List<String> getTemplatesInCategory(Class<? extends Annotation> category) {
87          List<String> templatesInCategory = categoryUsages.get(category);
88          if (templatesInCategory == null)
89              return new ArrayList<String>();
90          return templatesInCategory;
91      }
92  }