001: /*--
002:
003: Copyright (C) 2000-2003 Anthony Eden.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The name "EdenLib" must not be used to endorse or promote products
019: derived from this software without prior written permission. For
020: written permission, please contact me@anthonyeden.com.
021:
022: 4. Products derived from this software may not be called "EdenLib", nor
023: may "EdenLib" appear in their name, without prior written permission
024: from Anthony Eden (me@anthonyeden.com).
025:
026: In addition, I request (but do not require) that you include in the
027: end-user documentation provided with the redistribution and/or in the
028: software itself an acknowledgement equivalent to the following:
029: "This product includes software developed by
030: Anthony Eden (http://www.anthonyeden.com/)."
031:
032: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
033: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
034: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
035: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
036: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
037: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
038: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
039: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
040: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
041: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
042: POSSIBILITY OF SUCH DAMAGE.
043:
044: For more information on EdenLib, please see <http://edenlib.sf.net/>.
045:
046: */
047:
048: package com.anthonyeden.lib.config;
049:
050: import java.io.OutputStream;
051: import java.io.Writer;
052:
053: /**
054: * Interface implemented by configuration objects which are mutable.
055: *
056: * @author Anthony Eden
057: * @author <a href="mailto:florin.patrascu@gmail.com">Florin T.PATRASCU</a>
058: */
059:
060: public interface MutableConfiguration extends Configuration {
061:
062: /**
063: * Set the node name.
064: *
065: * @param name The new node name
066: */
067:
068: public void setName(String name);
069:
070: /**
071: * Add a child node with no child value to the configuration. This
072: * method should be the same as calling
073: * <code>addChild(name, null)</code>
074: *
075: * @param name The name of the new configuration node
076: * @return The configuration node
077: */
078:
079: public MutableConfiguration addChild(String name);
080:
081: /**
082: * Add a child node to the configuration. The value's toString() method
083: * will be used to convert the value to a String.
084: *
085: * @param name The name of the new configuration node
086: * @param value The value of the new configuration node
087: * @return The configuration node
088: */
089:
090: public MutableConfiguration addChild(String name, Object value);
091:
092: /**
093: * Add a child node to the configuration. The value's toString() method
094: * will be used to convert the value to a String. If the value is null use the
095: * default value. [patch from Jakub]
096: *
097: * @param name The name of the new configuration node
098: * @param value The value of the new configuration node
099: * @param defaultValue value to use if the value was null
100: * @return The configuration node
101: */
102: public MutableConfiguration addChild(String name, Object value,
103: Object defaultValue);
104:
105: /**
106: * Add the configuration object as a child of this configuration object.
107: *
108: * @param configuration The child configuration object
109: */
110:
111: public void addChild(Configuration configuration);
112:
113: /**
114: * Remove the specified configuration object.
115: *
116: * @param configuration The child configuration object
117: */
118:
119: public void removeChild(Configuration configuration);
120:
121: /**
122: * Add an attribute with the given name. The value's toString() method
123: * will be used to convert the value to a String.
124: *
125: * @param name The attribute name
126: * @param value The attribute value
127: */
128:
129: public void addAttribute(String name, Object value);
130:
131: /**
132: * Set the configuration object's value.
133: *
134: * @param value The new value
135: */
136:
137: public void setValue(String value);
138:
139: /**
140: * Remove all of the children of this configuration node.
141: */
142:
143: public void clearChildren();
144:
145: /**
146: * Save the configuration data to the specified output stream. Not all
147: * implementations will support writing configuration data.
148: *
149: * @param out The OutputStream
150: * @throws ConfigurationException
151: */
152:
153: public void save(OutputStream out) throws ConfigurationException;
154:
155: /**
156: * Save the configuration data to the specified output stream. Not all
157: * implementations will support writing configuration data.
158: *
159: * @param out The Writer
160: * @throws ConfigurationException
161: */
162:
163: public void save(Writer out) throws ConfigurationException;
164:
165: }
|