1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  public class SafeProperties extends Properties {
33  
34      public SafeProperties() {
35          super();
36      }
37  
38      public synchronized Object get(Object key) {
39          Object value = super.get(key);
40  
41          value = _decode((String)value);
42  
43          return value;
44      }
45  
46      public String getEncodedProperty(String key) {
47          return super.getProperty(key);
48      }
49  
50      public String getProperty(String key) {
51          return (String)get(key);
52      }
53  
54      public synchronized Object put(Object key, Object value) {
55          if (key == null) {
56              return null;
57          }
58          else {
59              if (value == null) {
60                  return super.remove(key);
61              }
62              else {
63                  value = _encode((String)value);
64  
65                  return super.put(key, value);
66              }
67          }
68      }
69  
70      public synchronized Object remove(Object key) {
71          if (key == null) {
72              return null;
73          }
74          else {
75              return super.remove(key);
76          }
77      }
78  
79      private static String _decode(String value) {
80          return StringUtil.replace(
81              value, _SAFE_NEWLINE_CHARACTER, StringPool.NEW_LINE);
82      }
83  
84      private static String _encode(String value) {
85          return StringUtil.replace(
86              value,
87              new String[] {
88                  StringPool.RETURN_NEW_LINE, StringPool.NEW_LINE,
89                  StringPool.RETURN
90              },
91              new String[] {
92                  _SAFE_NEWLINE_CHARACTER, _SAFE_NEWLINE_CHARACTER,
93                  _SAFE_NEWLINE_CHARACTER
94              });
95      }
96  
97      private static final String _SAFE_NEWLINE_CHARACTER =
98          "_SAFE_NEWLINE_CHARACTER_";
99  
100 }