View Javadoc

1   /*
2    * Copyright (c) 2003, Henri Yandell
3    * All rights reserved.
4    * 
5    * Redistribution and use in source and binary forms, with or 
6    * without modification, are permitted provided that the 
7    * following conditions are met:
8    * 
9    * + Redistributions of source code must retain the above copyright notice, 
10   *   this list of conditions and the following disclaimer.
11   * 
12   * + Redistributions in binary form must reproduce the above copyright notice, 
13   *   this list of conditions and the following disclaimer in the documentation 
14   *   and/or other materials provided with the distribution.
15   * 
16   * + Neither the name of Simple-JNDI nor the names of its contributors 
17   *   may be used to endorse or promote products derived from this software 
18   *   without specific prior written permission.
19   * 
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
23   * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
30   * POSSIBILITY OF SUCH DAMAGE.
31   */
32  
33  package org.osjava.sj.loader.util;
34  
35  import java.io.IOException;
36  import java.io.InputStream;
37  import java.io.OutputStream;
38  
39  import java.util.ArrayList;
40  import java.util.Collections;
41  import java.util.Enumeration;
42  import java.util.LinkedList;
43  import java.util.List;
44  import java.util.Properties;
45  import java.util.Set;
46  
47  public abstract class AbstractProperties extends Properties {
48  
49      private String delimiter = ".";
50  
51      public abstract void load(InputStream in) throws IOException;
52  
53      public void setDelimiter(String delimiter) {
54          this.delimiter = delimiter;
55      }
56  
57      public String getDelimiter() {
58          return this.delimiter;
59      }
60  
61      public synchronized Object put(Object key, Object value) {
62          if(index.contains(key)) {
63              Object obj = get(key);
64              if( !(obj instanceof List)) {
65                  List list = new LinkedList();
66                  list.add(obj);
67                  obj = list;
68              } 
69              ((List)obj).add(value);
70              value = obj;
71          }
72          if(!index.contains(key)) {
73              index.add(key);
74          }
75          return super.put(key, value);
76      }
77  
78      // our index for the ordering
79      protected ArrayList index = new ArrayList();
80  
81      public AbstractProperties() {
82          super();
83      }
84  
85      // the props attribute is for defaults. These will need to be 
86      // remembered for the save/store method.
87      public AbstractProperties(Properties props) {
88          super(props);
89      }
90  
91      public synchronized Object setProperty(String key, String value) {
92          return put(key,value);
93      }
94      
95      public synchronized Object remove(Object key) {
96          index.remove(key);
97          return super.remove(key);
98      }
99      
100     // simple implementation that depends on keySet.
101     public synchronized Enumeration propertyNames() {
102         return Collections.enumeration( keySet() );
103     }
104     public synchronized Enumeration keys() {
105         return propertyNames();
106     }
107     
108     public synchronized Set keySet() {
109         return new OrderedSet(index);
110     }
111  
112     // TODO: Handle both save and store.
113     /***
114      * Currently will write out defaults as well, which is not 
115      * in the specification.
116      */
117     public void save(OutputStream outstrm, String header) {
118         super.save(outstrm,header);
119     }
120     /***
121      * Currently will write out defaults as well, which is not 
122      * in the specification.
123      */
124     public void store(OutputStream outstrm, String header) throws IOException {
125         super.store(outstrm,header);
126     }
127 
128 }