1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.util;
24  
25  import java.util.Properties;
26  
27  /**
28   * <a href="SafeProperties.java.html"><b><i>View Source</i></b></a>
29   *
30   * @author Brian Wing Shun Chan
31   *
32   */
33  public class SafeProperties extends Properties {
34  
35      public SafeProperties() {
36          super();
37      }
38  
39      public synchronized Object get(Object key) {
40          Object value = super.get(key);
41  
42          value = _decode((String)value);
43  
44          return value;
45      }
46  
47      public String getEncodedProperty(String key) {
48          return super.getProperty(key);
49      }
50  
51      public String getProperty(String key) {
52          return (String)get(key);
53      }
54  
55      public synchronized Object put(Object key, Object value) {
56          if (key == null) {
57              return null;
58          }
59          else {
60              if (value == null) {
61                  return super.remove(key);
62              }
63              else {
64                  value = _encode((String)value);
65  
66                  return super.put(key, value);
67              }
68          }
69      }
70  
71      public synchronized Object remove(Object key) {
72          if (key == null) {
73              return null;
74          }
75          else {
76              return super.remove(key);
77          }
78      }
79  
80      private static String _decode(String value) {
81          return StringUtil.replace(
82              value, _SAFE_NEWLINE_CHARACTER, StringPool.NEW_LINE);
83      }
84  
85      private static String _encode(String value) {
86          return StringUtil.replace(
87              value,
88              new String[] {
89                  StringPool.RETURN_NEW_LINE, StringPool.NEW_LINE,
90                  StringPool.RETURN
91              },
92              new String[] {
93                  _SAFE_NEWLINE_CHARACTER, _SAFE_NEWLINE_CHARACTER,
94                  _SAFE_NEWLINE_CHARACTER
95              });
96      }
97  
98      private static final String _SAFE_NEWLINE_CHARACTER =
99          "_SAFE_NEWLINE_CHARACTER_";
100 
101 }