View Javadoc
1   /**
2    * This file Copyright (c) 2003-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.commands;
35  
36  import info.magnolia.commands.chain.Catalog;
37  import info.magnolia.commands.chain.Command;
38  
39  import java.util.Collections;
40  import java.util.HashMap;
41  import java.util.Iterator;
42  import java.util.Map;
43  import java.util.Set;
44  
45  /**
46   * Named command catalogs. Used to choose from multiple commands of the same
47   * name. The commands from catalog with name matching the repository will be
48   * used.
49   * Replaces the functionality of the org.apache.commons.chain.CatalogBase class.
50   */
51  public class MgnlCatalog implements Catalog {
52  
53      private String name;
54      protected Map<String, Command> commands = Collections.synchronizedMap(new HashMap<String, Command>());
55  
56      public MgnlCatalog() {
57      }
58  
59      public MgnlCatalog(Map<String, Command> commands) {
60          this.commands = Collections.synchronizedMap(commands);
61      }
62  
63      @Override
64      public void addCommand(String name, Command command) {
65          commands.put(name, command);
66      }
67  
68      @Override
69      public Command getCommand(String name) {
70          return commands.get(name);
71      }
72  
73      @Override
74      public Set<String> getNames() {
75          return (commands.keySet());
76      }
77  
78      @Override
79      public String toString() {
80          Iterator names = getNames().iterator();
81          StringBuffer str = new StringBuffer("[" + this.getClass().getName() + ": ");
82          while (names.hasNext()) {
83              str.append(names.next());
84              if (names.hasNext()) {
85                  str.append(", ");
86              }
87          }
88          str.append("]");
89          return str.toString();
90      }
91  
92      public String getName() {
93          return this.name;
94      }
95  
96      public void setName(String name) {
97          this.name = name;
98      }
99  }