Java Properties Load from File loadWithTrimmedValues(InputStream iStr, Properties prop)

Description

Read a set of properties from the received input stream, strip off any excess white space that exists in those property values, and then add those newly-read properties to the received Properties object; not explicitly removing the whitespace here can lead to problems.

License

Apache License

Parameter

Parameter	Description
iStr	An input stream from which the new properties are to be loaded (should already be initialized).
prop	A set of properties to which the properties from iStr will be added (should already be initialized). Copied here to avoid dependency on an engine class.

Declaration

private static void loadWithTrimmedValues(InputStream iStr, Properties prop) throws IOException

Method Source Code

//package com.java2s;
/*//from   w  w w  .  java  2 s .c om
 * Apache Derby is a subproject of the Apache DB project, and is licensed under
 * the Apache License, Version 2.0 (the "License"); you may not use these files
 * except in compliance with the License. You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Splice Machine, Inc. has modified this file.
 *
 * All Splice Machine modifications are Copyright 2012 - 2016 Splice Machine, Inc.,
 * and are licensed to you under the License; you may not use this file except in
 * compliance with the License.
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 */

import java.io.InputStream;
import java.io.IOException;

import java.util.Properties;

public class Main {
    /** 
     * Read a set of properties from the received input stream, strip
     * off any excess white space that exists in those property values,
     * and then add those newly-read properties to the received
     * Properties object; not explicitly removing the whitespace here can
     * lead to problems.
     *
     * This method exists because of the manner in which the jvm reads
     * properties from file--extra spaces are ignored after a _key_, but
     * if they exist at the _end_ of a property decl line (i.e. as part
     * of a _value_), they are preserved, as outlined in the Java API:
     *
     * "Any whitespace after the key is skipped; if the first non-
     * whitespace character after the key is = or :, then it is ignored
      * and any whitespace characters after it are also skipped. All
     * remaining characters on the line become part of the associated
     * element string."
     *
     * Creates final properties set consisting of 'prop' plus all
     * properties loaded from 'iStr' (with the extra whitespace (if any)
     *  removed from all values), will be returned via the parameter.
     *
     * @param iStr An input stream from which the new properties are to be
     *  loaded (should already be initialized).
     * @param prop A set of properties to which the properties from
     *  iStr will be added (should already be initialized).
     *
     * Copied here to avoid dependency on an engine class.
     **/
    private static void loadWithTrimmedValues(InputStream iStr, Properties prop) throws IOException {

        // load the properties from the received input stream.
        Properties p = new Properties();
        p.load(iStr);

        // Now, trim off any excess whitespace, if any, and then
        // add the properties from file to the received Properties
        // set.
        for (java.util.Enumeration propKeys = p.propertyNames(); propKeys.hasMoreElements();) {
            // get the value, trim off the whitespace, then store it
            // in the received properties object.
            String tmpKey = (String) propKeys.nextElement();
            String tmpValue = p.getProperty(tmpKey);
            tmpValue = tmpValue.trim();
            prop.put(tmpKey, tmpValue);
        }

        return;

    }
}