View Javadoc

1   /**
2    * This file Copyright (c) 2011 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.init.properties;
35  
36  import info.magnolia.init.PropertySource;
37  
38  import java.util.HashSet;
39  import java.util.Properties;
40  import java.util.Set;
41  
42  /**
43   * Abstract implementation of {@link PropertySource}, providing the basic mechanisms
44   * for implementation based on an instance of {@link Properties}.
45   *
46   * @author gjoseph
47   * @version $Revision: $ ($Author: $)
48   */
49  public abstract class AbstractPropertySource implements PropertySource {
50      // can't use a Map<String, String>, as java.util.Properties is a Map<Object, Object>.
51      private final Properties properties;
52  
53      public AbstractPropertySource(Properties properties) {
54          this.properties = properties;
55      }
56  
57      @Override
58      public Set<String> getKeys() {
59          // TODO hum ...
60          final HashSet<String> keys = new HashSet<String>();
61          for (Object o : properties.keySet()) {
62              keys.add((String) o);
63          }
64          return keys;
65      }
66  
67      @Override
68      public String getProperty(String key) {
69          return properties.getProperty(key);
70      }
71  
72      @Override
73      public boolean getBooleanProperty(String property) {
74          return Boolean.parseBoolean(getProperty(property));
75      }
76  
77      @Override
78      public boolean hasProperty(String key) {
79          return properties.containsKey(key);
80      }
81  
82      @Override
83      public String describe() {
84          return "[" + getClass().getSimpleName() + "]";
85      }
86  
87      @Override
88      public String toString() {
89          return describe() + " with properties: " + properties.toString();
90      }
91  
92      protected Properties getProperties() {
93          return properties;
94      }
95  }