Properties.java revision 2362
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk/*
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Copyright (c) 1995, 2006, Oracle and/or its affiliates. All rights reserved.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * This code is free software; you can redistribute it and/or modify it
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * under the terms of the GNU General Public License version 2 only, as
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * published by the Free Software Foundation. Oracle designates this
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * particular file as subject to the "Classpath" exception as provided
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * by Oracle in the LICENSE file that accompanied this code.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * This code is distributed in the hope that it will be useful, but WITHOUT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * version 2 for more details (a copy is included in the LICENSE file that
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * accompanied this code).
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * You should have received a copy of the GNU General Public License version
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * 2 along with this work; if not, write to the Free Software Foundation,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * or visit www.oracle.com if you need additional information or have any
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * questions.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkpackage java.util;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.IOException;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.PrintStream;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.PrintWriter;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.InputStream;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.OutputStream;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.Reader;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.Writer;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.OutputStreamWriter;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport java.io.BufferedWriter;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk/**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The <code>Properties</code> class represents a persistent set of
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * properties. The <code>Properties</code> can be saved to a stream
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * or loaded from a stream. Each key and its corresponding value in
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the property list is a string.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * A property list can contain another property list as its
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * "defaults"; this second property list is searched if
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the property key is not found in the original property list.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Because <code>Properties</code> inherits from <code>Hashtable</code>, the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>put</code> and <code>putAll</code> methods can be applied to a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>Properties</code> object. Their use is strongly discouraged as they
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * allow the caller to insert entries whose keys or values are not
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>Strings</code>. The <code>setProperty</code> method should be used
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * instead. If the <code>store</code> or <code>save</code> method is called
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * on a "compromised" <code>Properties</code> object that contains a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * non-<code>String</code> key or value, the call will fail. Similarly,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the call to the <code>propertyNames</code> or <code>list</code> method
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * will fail if it is called on a "compromised" <code>Properties</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * object that contains a non-<code>String</code> key.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The {@link #load(java.io.Reader) load(Reader)} <tt>/</tt>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * {@link #store(java.io.Writer, java.lang.String) store(Writer, String)}
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * methods load and store properties from and to a character based stream
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * in a simple line-oriented format specified below.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The {@link #load(java.io.InputStream) load(InputStream)} <tt>/</tt>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * {@link #store(java.io.OutputStream, java.lang.String) store(OutputStream, String)}
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * methods work the same way as the load(Reader)/store(Writer, String) pair, except
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the input/output stream is encoded in ISO 8859-1 character encoding.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Characters that cannot be directly represented in this encoding can be written using
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <a href="http://java.sun.com/docs/books/jls/third_edition/html/lexical.html#3.3">Unicode escapes</a>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * ; only a single 'u' character is allowed in an escape
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * sequence. The native2ascii tool can be used to convert property files to and
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * from other character encodings.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p> The {@link #loadFromXML(InputStream)} and {@link
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * #storeToXML(OutputStream, String, String)} methods load and store properties
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * in a simple XML format. By default the UTF-8 character encoding is used,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * however a specific encoding may be specified if required. An XML properties
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * document has the following DOCTYPE declaration:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"&gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * </pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Note that the system URI (http://java.sun.com/dtd/properties.dtd) is
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <i>not</i> accessed when exporting or importing properties; it merely
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * serves as a string to uniquely identify the DTD, which is:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;?xml version="1.0" encoding="UTF-8"?&gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;!-- DTD for properties --&gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;!ELEMENT properties ( comment?, entry* ) &gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;!ATTLIST properties version CDATA #FIXED "1.0"&gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;!ELEMENT comment (#PCDATA) &gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;!ELEMENT entry (#PCDATA) &gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * &lt;!ATTLIST entry key CDATA #REQUIRED&gt;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * </pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>This class is thread-safe: multiple threads can share a single
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <tt>Properties</tt> object without the need for external synchronization.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @see <a href="../../../technotes/tools/solaris/native2ascii.html">native2ascii tool for Solaris</a>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @see <a href="../../../technotes/tools/windows/native2ascii.html">native2ascii tool for Windows</a>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @author Arthur van Hoff
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @author Michael McCloskey
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @author Xueming Shen
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @since JDK1.0
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkpublic
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkclass Properties extends Hashtable<Object,Object> {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * use serialVersionUID from JDK 1.1.X for interoperability
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk private static final long serialVersionUID = 4112578634029874840L;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * A property list that contains default values for any keys not
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * found in this property list.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @serial
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk protected Properties defaults;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Creates an empty property list with no default values.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public Properties() {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk this(null);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Creates an empty property list with the specified defaults.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @param defaults the defaults.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public Properties(Properties defaults) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk this.defaults = defaults;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Calls the <tt>Hashtable</tt> method <code>put</code>. Provided for
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * parallelism with the <tt>getProperty</tt> method. Enforces use of
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * strings for property keys and values. The value returned is the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * result of the <tt>Hashtable</tt> call to <code>put</code>.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @param key the key to be placed into this property list.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @param value the value corresponding to <tt>key</tt>.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @return the previous value of the specified key in this property
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * list, or <code>null</code> if it did not have one.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @see #getProperty
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @since 1.2
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public synchronized Object setProperty(String key, String value) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk return put(key, value);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Reads a property list (key and element pairs) from the input
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * character stream in a simple line-oriented format.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Properties are processed in terms of lines. There are two
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * kinds of line, <i>natural lines</i> and <i>logical lines</i>.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * A natural line is defined as a line of
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * characters that is terminated either by a set of line terminator
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * characters (<code>\n</code> or <code>\r</code> or <code>\r\n</code>)
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * or by the end of the stream. A natural line may be either a blank line,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * a comment line, or hold all or some of a key-element pair. A logical
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * line holds all the data of a key-element pair, which may be spread
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * out across several adjacent natural lines by escaping
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the line terminator sequence with a backslash character
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>\</code>. Note that a comment line cannot be extended
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * in this manner; every natural line that is a comment must have
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * its own comment indicator, as described below. Lines are read from
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * input until the end of the stream is reached.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * A natural line that contains only white space characters is
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * considered blank and is ignored. A comment line has an ASCII
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>'#'</code> or <code>'!'</code> as its first non-white
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * space character; comment lines are also ignored and do not
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * encode key-element information. In addition to line
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * terminators, this format considers the characters space
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * (<code>' '</code>, <code>'&#92;u0020'</code>), tab
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * (<code>'\t'</code>, <code>'&#92;u0009'</code>), and form feed
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * (<code>'\f'</code>, <code>'&#92;u000C'</code>) to be white
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * space.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * If a logical line is spread across several natural lines, the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * backslash escaping the line terminator sequence, the line
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * terminator sequence, and any white space at the start of the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * following line have no affect on the key or element values.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The remainder of the discussion of key and element parsing
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * (when loading) will assume all the characters constituting
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the key and element appear on a single natural line after
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * line continuation characters have been removed. Note that
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * it is <i>not</i> sufficient to only examine the character
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * preceding a line terminator sequence to decide if the line
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * terminator is escaped; there must be an odd number of
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * contiguous backslashes for the line terminator to be escaped.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Since the input is processed from left to right, a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * non-zero even number of 2<i>n</i> contiguous backslashes
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * before a line terminator (or elsewhere) encodes <i>n</i>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * backslashes after escape processing.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The key contains all of the characters in the line starting
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * with the first non-white space character and up to, but not
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * including, the first unescaped <code>'='</code>,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>':'</code>, or white space character other than a line
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * terminator. All of these key termination characters may be
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * included in the key by escaping them with a preceding backslash
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * character; for example,<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>\:\=</code><p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * would be the two-character key <code>":="</code>. Line
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * terminator characters can be included using <code>\r</code> and
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>\n</code> escape sequences. Any white space after the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * key is skipped; if the first non-white space character after
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the key is <code>'='</code> or <code>':'</code>, then it is
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * ignored and any white space characters after it are also
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * skipped. All remaining characters on the line become part of
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the associated element string; if there are no remaining
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * characters, the element is the empty string
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>&quot;&quot;</code>. Once the raw character sequences
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * constituting the key and element are identified, escape
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * processing is performed as described above.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * As an example, each of the following three lines specifies the key
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>"Truth"</code> and the associated element value
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>"Beauty"</code>:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Truth = Beauty
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Truth:Beauty
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Truth :Beauty
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * </pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * As another example, the following three lines specify a single
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * property:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * fruits apple, banana, pear, \
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * cantaloupe, watermelon, \
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * kiwi, mango
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * </pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The key is <code>"fruits"</code> and the associated element is:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <pre>"apple, banana, pear, cantaloupe, watermelon, kiwi, mango"</pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Note that a space appears before each <code>\</code> so that a space
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * will appear after each comma in the final result; the <code>\</code>,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * line terminator, and leading white space on the continuation line are
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * merely discarded and are <i>not</i> replaced by one or more other
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * characters.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * As a third example, the line:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <pre>cheeses
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * </pre>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * specifies that the key is <code>"cheeses"</code> and the associated
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * element is the empty string <code>""</code>.<p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <a name="unicodeescapes"></a>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Characters in keys and elements can be represented in escape
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * sequences similar to those used for character and string literals
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * (see <a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * href="http://java.sun.com/docs/books/jls/third_edition/html/lexical.html#3.3">&sect;3.3</a>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * and <a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * href="http://java.sun.com/docs/books/jls/third_edition/html/lexical.html#3.10.6">&sect;3.10.6</a>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * of the <i>Java Language Specification</i>).
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The differences from the character escape sequences and Unicode
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * escapes used for characters and strings are:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <ul>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <li> Octal escapes are not recognized.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <li> The character sequence <code>\b</code> does <i>not</i>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * represent a backspace character.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <li> The method does not treat a backslash character,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>\</code>, before a non-valid escape character as an
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * error; the backslash is silently dropped. For example, in a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Java string the sequence <code>"\z"</code> would cause a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * compile time error. In contrast, this method silently drops
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the backslash. Therefore, this method treats the two character
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * sequence <code>"\b"</code> as equivalent to the single
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * character <code>'b'</code>.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <li> Escapes are not necessary for single and double quotes;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * however, by the rule above, single and double quote characters
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * preceded by a backslash still yield single and double quote
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * characters, respectively.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <li> Only a single 'u' character is allowed in a Uniocde escape
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * sequence.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * </ul>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The specified stream remains open after this method returns.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @param reader the input character stream.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @throws IOException if an error occurred when reading from the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * input stream.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @throws IllegalArgumentException if a malformed Unicode escape
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * appears in the input.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @since 1.6
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public synchronized void load(Reader reader) throws IOException {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk load0(new LineReader(reader));
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Reads a property list (key and element pairs) from the input
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * byte stream. The input stream is in a simple line-oriented
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * format as specified in
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * {@link #load(java.io.Reader) load(Reader)} and is assumed to use
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the ISO 8859-1 character encoding; that is each byte is one Latin1
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * character. Characters not in Latin1, and certain special characters,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * are represented in keys and elements using
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <a href="http://java.sun.com/docs/books/jls/third_edition/html/lexical.html#3.3">Unicode escapes</a>.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <p>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The specified stream remains open after this method returns.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @param inStream the input stream.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @exception IOException if an error occurred when reading from the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * input stream.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @throws IllegalArgumentException if the input stream contains a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * malformed Unicode escape sequence.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @since 1.2
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public synchronized void load(InputStream inStream) throws IOException {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk load0(new LineReader(inStream));
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk private void load0 (LineReader lr) throws IOException {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char[] convtBuf = new char[1024];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int limit;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int keyLen;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int valueStart;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char c;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean hasSep;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean precedingBackslash;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk while ((limit = lr.readLine()) >= 0) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk c = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk keyLen = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk valueStart = limit;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk hasSep = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk //System.out.println("line=<" + new String(lineBuf, 0, limit) + ">");
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk precedingBackslash = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk while (keyLen < limit) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk c = lr.lineBuf[keyLen];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk //need check if escaped.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if ((c == '=' || c == ':') && !precedingBackslash) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk valueStart = keyLen + 1;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk hasSep = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk break;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else if ((c == ' ' || c == '\t' || c == '\f') && !precedingBackslash) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk valueStart = keyLen + 1;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk break;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c == '\\') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk precedingBackslash = !precedingBackslash;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk precedingBackslash = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk keyLen++;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk while (valueStart < limit) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk c = lr.lineBuf[valueStart];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c != ' ' && c != '\t' && c != '\f') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (!hasSep && (c == '=' || c == ':')) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk hasSep = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk break;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk valueStart++;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk String key = loadConvert(lr.lineBuf, 0, keyLen, convtBuf);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk String value = loadConvert(lr.lineBuf, valueStart, limit - valueStart, convtBuf);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk put(key, value);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /* Read in a "logical line" from an InputStream/Reader, skip all comment
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * and blank lines and filter out those leading whitespace characters
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * (\u0020, \u0009 and \u000c) from the beginning of a "natural line".
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Method returns the char length of the "logical line" and stores
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * the line in "lineBuf".
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk class LineReader {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public LineReader(InputStream inStream) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk this.inStream = inStream;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk inByteBuf = new byte[8192];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public LineReader(Reader reader) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk this.reader = reader;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk inCharBuf = new char[8192];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk byte[] inByteBuf;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char[] inCharBuf;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char[] lineBuf = new char[1024];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int inLimit = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int inOff = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk InputStream inStream;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk Reader reader;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int readLine() throws IOException {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int len = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char c = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean skipWhiteSpace = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean isCommentLine = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean isNewLine = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean appendedLineBegin = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean precedingBackslash = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean skipLF = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk while (true) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (inOff >= inLimit) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk inLimit = (inStream==null)?reader.read(inCharBuf)
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk :inStream.read(inByteBuf);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk inOff = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (inLimit <= 0) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (len == 0 || isCommentLine) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk return -1;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk return len;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (inStream != null) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk //The line below is equivalent to calling a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk //ISO8859-1 decoder.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk c = (char) (0xff & inByteBuf[inOff++]);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk c = inCharBuf[inOff++];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (skipLF) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk skipLF = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c == '\n') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk continue;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (skipWhiteSpace) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c == ' ' || c == '\t' || c == '\f') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk continue;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (!appendedLineBegin && (c == '\r' || c == '\n')) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk continue;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk skipWhiteSpace = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk appendedLineBegin = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (isNewLine) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk isNewLine = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c == '#' || c == '!') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk isCommentLine = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk continue;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c != '\n' && c != '\r') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk lineBuf[len++] = c;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (len == lineBuf.length) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int newLength = lineBuf.length * 2;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (newLength < 0) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk newLength = Integer.MAX_VALUE;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char[] buf = new char[newLength];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk System.arraycopy(lineBuf, 0, buf, 0, lineBuf.length);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk lineBuf = buf;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk //flip the preceding backslash flag
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c == '\\') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk precedingBackslash = !precedingBackslash;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk precedingBackslash = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk // reached EOL
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (isCommentLine || len == 0) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk isCommentLine = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk isNewLine = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk skipWhiteSpace = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk len = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk continue;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (inOff >= inLimit) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk inLimit = (inStream==null)
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk ?reader.read(inCharBuf)
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk :inStream.read(inByteBuf);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk inOff = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (inLimit <= 0) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk return len;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (precedingBackslash) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk len -= 1;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk //skip the leading whitespace characters in following line
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk skipWhiteSpace = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk appendedLineBegin = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk precedingBackslash = false;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (c == '\r') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk skipLF = true;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk return len;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /*
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Converts encoded &#92;uxxxx to unicode chars
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * and changes special saved chars to their original forms
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk private String loadConvert (char[] in, int off, int len, char[] convtBuf) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (convtBuf.length < len) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int newLen = len * 2;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (newLen < 0) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk newLen = Integer.MAX_VALUE;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk convtBuf = new char[newLen];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char aChar;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char[] out = convtBuf;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int outLen = 0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int end = off + len;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk while (off < end) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk aChar = in[off++];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (aChar == '\\') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk aChar = in[off++];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if(aChar == 'u') {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk // Read the xxxx
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int value=0;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk for (int i=0; i<4; i++) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk aChar = in[off++];
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk switch (aChar) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk case '0': case '1': case '2': case '3': case '4':
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk case '5': case '6': case '7': case '8': case '9':
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk value = (value << 4) + aChar - '0';
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk break;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk case 'a': case 'b': case 'c':
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk case 'd': case 'e': case 'f':
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk value = (value << 4) + 10 + aChar - 'a';
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk break;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk case 'A': case 'B': case 'C':
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk case 'D': case 'E': case 'F':
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk value = (value << 4) + 10 + aChar - 'A';
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk break;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk default:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk throw new IllegalArgumentException(
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk "Malformed \\uxxxx encoding.");
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk out[outLen++] = (char)value;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (aChar == 't') aChar = '\t';
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk else if (aChar == 'r') aChar = '\r';
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk else if (aChar == 'n') aChar = '\n';
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk else if (aChar == 'f') aChar = '\f';
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk out[outLen++] = aChar;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk } else {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk out[outLen++] = aChar;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk return new String (out, 0, outLen);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /*
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Converts unicodes to encoded &#92;uxxxx and escapes
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * special characters with a preceding slash
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk private String saveConvert(String theString,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean escapeSpace,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk boolean escapeUnicode) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int len = theString.length();
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int bufLen = len * 2;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk if (bufLen < 0) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk bufLen = Integer.MAX_VALUE;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk }
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk StringBuffer outBuffer = new StringBuffer(bufLen);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk for(int x=0; x<len; x++) {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char aChar = theString.charAt(x);
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk // Handle common case first, selecting largest block that
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk // avoids the specials below
if ((aChar > 61) && (aChar < 127)) {
if (aChar == '\\') {
outBuffer.append('\\'); outBuffer.append('\\');
continue;
}
outBuffer.append(aChar);
continue;
}
switch(aChar) {
case ' ':
if (x == 0 || escapeSpace)
outBuffer.append('\\');
outBuffer.append(' ');
break;
case '\t':outBuffer.append('\\'); outBuffer.append('t');
break;
case '\n':outBuffer.append('\\'); outBuffer.append('n');
break;
case '\r':outBuffer.append('\\'); outBuffer.append('r');
break;
case '\f':outBuffer.append('\\'); outBuffer.append('f');
break;
case '=': // Fall through
case ':': // Fall through
case '#': // Fall through
case '!':
outBuffer.append('\\'); outBuffer.append(aChar);
break;
default:
if (((aChar < 0x0020) || (aChar > 0x007e)) & escapeUnicode ) {
outBuffer.append('\\');
outBuffer.append('u');
outBuffer.append(toHex((aChar >> 12) & 0xF));
outBuffer.append(toHex((aChar >> 8) & 0xF));
outBuffer.append(toHex((aChar >> 4) & 0xF));
outBuffer.append(toHex( aChar & 0xF));
} else {
outBuffer.append(aChar);
}
}
}
return outBuffer.toString();
}
private static void writeComments(BufferedWriter bw, String comments)
throws IOException {
bw.write("#");
int len = comments.length();
int current = 0;
int last = 0;
char[] uu = new char[6];
uu[0] = '\\';
uu[1] = 'u';
while (current < len) {
char c = comments.charAt(current);
if (c > '\u00ff' || c == '\n' || c == '\r') {
if (last != current)
bw.write(comments.substring(last, current));
if (c > '\u00ff') {
uu[2] = toHex((c >> 12) & 0xf);
uu[3] = toHex((c >> 8) & 0xf);
uu[4] = toHex((c >> 4) & 0xf);
uu[5] = toHex( c & 0xf);
bw.write(new String(uu));
} else {
bw.newLine();
if (c == '\r' &&
current != len - 1 &&
comments.charAt(current + 1) == '\n') {
current++;
}
if (current == len - 1 ||
(comments.charAt(current + 1) != '#' &&
comments.charAt(current + 1) != '!'))
bw.write("#");
}
last = current + 1;
}
current++;
}
if (last != current)
bw.write(comments.substring(last, current));
bw.newLine();
}
/**
* Calls the <code>store(OutputStream out, String comments)</code> method
* and suppresses IOExceptions that were thrown.
*
* @deprecated This method does not throw an IOException if an I/O error
* occurs while saving the property list. The preferred way to save a
* properties list is via the <code>store(OutputStream out,
* String comments)</code> method or the
* <code>storeToXML(OutputStream os, String comment)</code> method.
*
* @param out an output stream.
* @param comments a description of the property list.
* @exception ClassCastException if this <code>Properties</code> object
* contains any keys or values that are not
* <code>Strings</code>.
*/
@Deprecated
public synchronized void save(OutputStream out, String comments) {
try {
store(out, comments);
} catch (IOException e) {
}
}
/**
* Writes this property list (key and element pairs) in this
* <code>Properties</code> table to the output character stream in a
* format suitable for using the {@link #load(java.io.Reader) load(Reader)}
* method.
* <p>
* Properties from the defaults table of this <code>Properties</code>
* table (if any) are <i>not</i> written out by this method.
* <p>
* If the comments argument is not null, then an ASCII <code>#</code>
* character, the comments string, and a line separator are first written
* to the output stream. Thus, the <code>comments</code> can serve as an
* identifying comment. Any one of a line feed ('\n'), a carriage
* return ('\r'), or a carriage return followed immediately by a line feed
* in comments is replaced by a line separator generated by the <code>Writer</code>
* and if the next character in comments is not character <code>#</code> or
* character <code>!</code> then an ASCII <code>#</code> is written out
* after that line separator.
* <p>
* Next, a comment line is always written, consisting of an ASCII
* <code>#</code> character, the current date and time (as if produced
* by the <code>toString</code> method of <code>Date</code> for the
* current time), and a line separator as generated by the <code>Writer</code>.
* <p>
* Then every entry in this <code>Properties</code> table is
* written out, one per line. For each entry the key string is
* written, then an ASCII <code>=</code>, then the associated
* element string. For the key, all space characters are
* written with a preceding <code>\</code> character. For the
* element, leading space characters, but not embedded or trailing
* space characters, are written with a preceding <code>\</code>
* character. The key and element characters <code>#</code>,
* <code>!</code>, <code>=</code>, and <code>:</code> are written
* with a preceding backslash to ensure that they are properly loaded.
* <p>
* After the entries have been written, the output stream is flushed.
* The output stream remains open after this method returns.
* <p>
*
* @param writer an output character stream writer.
* @param comments a description of the property list.
* @exception IOException if writing this property list to the specified
* output stream throws an <tt>IOException</tt>.
* @exception ClassCastException if this <code>Properties</code> object
* contains any keys or values that are not <code>Strings</code>.
* @exception NullPointerException if <code>writer</code> is null.
* @since 1.6
*/
public void store(Writer writer, String comments)
throws IOException
{
store0((writer instanceof BufferedWriter)?(BufferedWriter)writer
: new BufferedWriter(writer),
comments,
false);
}
/**
* Writes this property list (key and element pairs) in this
* <code>Properties</code> table to the output stream in a format suitable
* for loading into a <code>Properties</code> table using the
* {@link #load(InputStream) load(InputStream)} method.
* <p>
* Properties from the defaults table of this <code>Properties</code>
* table (if any) are <i>not</i> written out by this method.
* <p>
* This method outputs the comments, properties keys and values in
* the same format as specified in
* {@link #store(java.io.Writer, java.lang.String) store(Writer)},
* with the following differences:
* <ul>
* <li>The stream is written using the ISO 8859-1 character encoding.
*
* <li>Characters not in Latin-1 in the comments are written as
* <code>&#92;u</code><i>xxxx</i> for their appropriate unicode
* hexadecimal value <i>xxxx</i>.
*
* <li>Characters less than <code>&#92;u0020</code> and characters greater
* than <code>&#92;u007E</code> in property keys or values are written
* as <code>&#92;u</code><i>xxxx</i> for the appropriate hexadecimal
* value <i>xxxx</i>.
* </ul>
* <p>
* After the entries have been written, the output stream is flushed.
* The output stream remains open after this method returns.
* <p>
* @param out an output stream.
* @param comments a description of the property list.
* @exception IOException if writing this property list to the specified
* output stream throws an <tt>IOException</tt>.
* @exception ClassCastException if this <code>Properties</code> object
* contains any keys or values that are not <code>Strings</code>.
* @exception NullPointerException if <code>out</code> is null.
* @since 1.2
*/
public void store(OutputStream out, String comments)
throws IOException
{
store0(new BufferedWriter(new OutputStreamWriter(out, "8859_1")),
comments,
true);
}
private void store0(BufferedWriter bw, String comments, boolean escUnicode)
throws IOException
{
if (comments != null) {
writeComments(bw, comments);
}
bw.write("#" + new Date().toString());
bw.newLine();
synchronized (this) {
for (Enumeration e = keys(); e.hasMoreElements();) {
String key = (String)e.nextElement();
String val = (String)get(key);
key = saveConvert(key, true, escUnicode);
/* No need to escape embedded and trailing spaces for value, hence
* pass false to flag.
*/
val = saveConvert(val, false, escUnicode);
bw.write(key + "=" + val);
bw.newLine();
}
}
bw.flush();
}
/**
* Loads all of the properties represented by the XML document on the
* specified input stream into this properties table.
*
* <p>The XML document must have the following DOCTYPE declaration:
* <pre>
* &lt;!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"&gt;
* </pre>
* Furthermore, the document must satisfy the properties DTD described
* above.
*
* <p>The specified stream is closed after this method returns.
*
* @param in the input stream from which to read the XML document.
* @throws IOException if reading from the specified input stream
* results in an <tt>IOException</tt>.
* @throws InvalidPropertiesFormatException Data on input stream does not
* constitute a valid XML document with the mandated document type.
* @throws NullPointerException if <code>in</code> is null.
* @see #storeToXML(OutputStream, String, String)
* @since 1.5
*/
public synchronized void loadFromXML(InputStream in)
throws IOException, InvalidPropertiesFormatException
{
if (in == null)
throw new NullPointerException();
XMLUtils.load(this, in);
in.close();
}
/**
* Emits an XML document representing all of the properties contained
* in this table.
*
* <p> An invocation of this method of the form <tt>props.storeToXML(os,
* comment)</tt> behaves in exactly the same way as the invocation
* <tt>props.storeToXML(os, comment, "UTF-8");</tt>.
*
* @param os the output stream on which to emit the XML document.
* @param comment a description of the property list, or <code>null</code>
* if no comment is desired.
* @throws IOException if writing to the specified output stream
* results in an <tt>IOException</tt>.
* @throws NullPointerException if <code>os</code> is null.
* @throws ClassCastException if this <code>Properties</code> object
* contains any keys or values that are not
* <code>Strings</code>.
* @see #loadFromXML(InputStream)
* @since 1.5
*/
public synchronized void storeToXML(OutputStream os, String comment)
throws IOException
{
if (os == null)
throw new NullPointerException();
storeToXML(os, comment, "UTF-8");
}
/**
* Emits an XML document representing all of the properties contained
* in this table, using the specified encoding.
*
* <p>The XML document will have the following DOCTYPE declaration:
* <pre>
* &lt;!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"&gt;
* </pre>
*
*<p>If the specified comment is <code>null</code> then no comment
* will be stored in the document.
*
* <p>The specified stream remains open after this method returns.
*
* @param os the output stream on which to emit the XML document.
* @param comment a description of the property list, or <code>null</code>
* if no comment is desired.
* @throws IOException if writing to the specified output stream
* results in an <tt>IOException</tt>.
* @throws NullPointerException if <code>os</code> is <code>null</code>,
* or if <code>encoding</code> is <code>null</code>.
* @throws ClassCastException if this <code>Properties</code> object
* contains any keys or values that are not
* <code>Strings</code>.
* @see #loadFromXML(InputStream)
* @since 1.5
*/
public synchronized void storeToXML(OutputStream os, String comment,
String encoding)
throws IOException
{
if (os == null)
throw new NullPointerException();
XMLUtils.save(this, os, comment, encoding);
}
/**
* Searches for the property with the specified key in this property list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @return the value in this property list with the specified key value.
* @see #setProperty
* @see #defaults
*/
public String getProperty(String key) {
Object oval = super.get(key);
String sval = (oval instanceof String) ? (String)oval : null;
return ((sval == null) && (defaults != null)) ? defaults.getProperty(key) : sval;
}
/**
* Searches for the property with the specified key in this property list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns the
* default value argument if the property is not found.
*
* @param key the hashtable key.
* @param defaultValue a default value.
*
* @return the value in this property list with the specified key value.
* @see #setProperty
* @see #defaults
*/
public String getProperty(String key, String defaultValue) {
String val = getProperty(key);
return (val == null) ? defaultValue : val;
}
/**
* Returns an enumeration of all the keys in this property list,
* including distinct keys in the default property list if a key
* of the same name has not already been found from the main
* properties list.
*
* @return an enumeration of all the keys in this property list, including
* the keys in the default property list.
* @throws ClassCastException if any key in this property list
* is not a string.
* @see java.util.Enumeration
* @see java.util.Properties#defaults
* @see #stringPropertyNames
*/
public Enumeration<?> propertyNames() {
Hashtable h = new Hashtable();
enumerate(h);
return h.keys();
}
/**
* Returns a set of keys in this property list where
* the key and its corresponding value are strings,
* including distinct keys in the default property list if a key
* of the same name has not already been found from the main
* properties list. Properties whose key or value is not
* of type <tt>String</tt> are omitted.
* <p>
* The returned set is not backed by the <tt>Properties</tt> object.
* Changes to this <tt>Properties</tt> are not reflected in the set,
* or vice versa.
*
* @return a set of keys in this property list where
* the key and its corresponding value are strings,
* including the keys in the default property list.
* @see java.util.Properties#defaults
* @since 1.6
*/
public Set<String> stringPropertyNames() {
Hashtable<String, String> h = new Hashtable<String, String>();
enumerateStringProperties(h);
return h.keySet();
}
/**
* Prints this property list out to the specified output stream.
* This method is useful for debugging.
*
* @param out an output stream.
* @throws ClassCastException if any key in this property list
* is not a string.
*/
public void list(PrintStream out) {
out.println("-- listing properties --");
Hashtable h = new Hashtable();
enumerate(h);
for (Enumeration e = h.keys() ; e.hasMoreElements() ;) {
String key = (String)e.nextElement();
String val = (String)h.get(key);
if (val.length() > 40) {
val = val.substring(0, 37) + "...";
}
out.println(key + "=" + val);
}
}
/**
* Prints this property list out to the specified output stream.
* This method is useful for debugging.
*
* @param out an output stream.
* @throws ClassCastException if any key in this property list
* is not a string.
* @since JDK1.1
*/
/*
* Rather than use an anonymous inner class to share common code, this
* method is duplicated in order to ensure that a non-1.1 compiler can
* compile this file.
*/
public void list(PrintWriter out) {
out.println("-- listing properties --");
Hashtable h = new Hashtable();
enumerate(h);
for (Enumeration e = h.keys() ; e.hasMoreElements() ;) {
String key = (String)e.nextElement();
String val = (String)h.get(key);
if (val.length() > 40) {
val = val.substring(0, 37) + "...";
}
out.println(key + "=" + val);
}
}
/**
* Enumerates all key/value pairs in the specified hashtable.
* @param h the hashtable
* @throws ClassCastException if any of the property keys
* is not of String type.
*/
private synchronized void enumerate(Hashtable h) {
if (defaults != null) {
defaults.enumerate(h);
}
for (Enumeration e = keys() ; e.hasMoreElements() ;) {
String key = (String)e.nextElement();
h.put(key, get(key));
}
}
/**
* Enumerates all key/value pairs in the specified hashtable
* and omits the property if the key or value is not a string.
* @param h the hashtable
*/
private synchronized void enumerateStringProperties(Hashtable<String, String> h) {
if (defaults != null) {
defaults.enumerateStringProperties(h);
}
for (Enumeration e = keys() ; e.hasMoreElements() ;) {
Object k = e.nextElement();
Object v = get(k);
if (k instanceof String && v instanceof String) {
h.put((String) k, (String) v);
}
}
}
/**
* Convert a nibble to a hex character
* @param nibble the nibble to convert.
*/
private static char toHex(int nibble) {
return hexDigit[(nibble & 0xF)];
}
/** A table of hex digits */
private static final char[] hexDigit = {
'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'
};
}