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.cms.util;
35
36 import java.util.Collection;
37 import java.util.LinkedHashMap;
38 import java.util.Properties;
39 import java.util.Set;
40
41 /**
42 * Subclass of java.util.Properties which keeps the order in which properties were loaded,
43 * by delegating to a LinkedHashMap.
44 *
45 * <strong>Warning:</strong> only the java.util.Map interface methods have been
46 * overloaded, so be weary when using java.util.Properties specific methods. (load, save,
47 * getProperty and setProperty are working.) (getProperty had to be explicitly overloaded
48 * too)
49 *
50 * The equals() method respects the Map.equals() contract, since the entrySet() method is
51 * delegating to the LinkedHashMap.
52 */
53 public class OrderedProperties extends Properties {
54 private final LinkedHashMap map = new LinkedHashMap();
55
56 @Override
57 public Object put(Object key, Object value) {
58 return map.put(key, value);
59 }
60
61 @Override
62 public Object get(Object key) {
63 return map.get(key);
64 }
65
66 @Override
67 public String getProperty(String key) {
68 return (String) get(key);
69 }
70
71 @Override
72 public boolean containsValue(Object value) {
73 return this.map.containsValue(value);
74 }
75
76 @Override
77 public boolean containsKey(Object key) {
78 return this.map.containsKey(key);
79 }
80
81 @Override
82 public Set entrySet() {
83 return this.map.entrySet();
84 }
85
86 @Override
87 public Set keySet() {
88 return this.map.keySet();
89 }
90
91 @Override
92 public Collection values() {
93 return this.map.values();
94 }
95
96 @Override
97 public int size() {
98 return this.map.size();
99 }
100
101 @Override
102 public boolean isEmpty() {
103 return this.map.isEmpty();
104 }
105 }