head	1.1;
access;
symbols;
locks; strict;
comment	@# @;


1.1
date	2001.08.28.18.12.23;	author leonardr;	state Exp;
branches;
next	;


desc
@@


1.1
log
@Moved code out into a utility class.
@
text
@/* ================================================================
 * Copyright (c) 2001 CollabNet.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 * any, must include the following acknowlegement: "This product includes
 * software developed by CollabNet (http://www.collab.net/)."
 * Alternately, this acknowlegement may appear in the software itself, if
 * and wherever such third-party acknowlegements normally appear.
 *
 * 4. The hosted project names must not be used to endorse or promote
 * products derived from this software without prior written
 * permission. For written permission, please contact info@@collab.net.
 *
 * 5. Products derived from this software may not use the "Tigris" name
 * nor may "Tigris" appear in their names without prior written
 * permission of CollabNet.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL COLLABNET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of CollabNet.
 */
package org.tigris.helm.util;

import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.IOException;

import java.util.Enumeration;
import java.util.Properties;

import org.apache.commons.util.StringUtils;
import org.apache.turbine.util.Log;

/**
 * Utilities for dealing with properties files.
 *
 * @@author <a href="mailto:dlr@@collab.net">Daniel Rall</a>
 * @@version $Id: FileUtil.java,v 1.3 2001/08/11 09:08:10 dlr Exp $
 *
 * Copyright (c) 2001 CollabNet, Inc.
 */
public class PropertiesUtil
{
    /**
     * Turn debug log output on/off
     */
    private static final boolean DEBUG = false;

    /**
     * Reads a properties file into a Properties object.
     *
     * @@param propertiesFile The name of the file with properties.
     * @@param theProperties  The Properties object into which to load file.
     *
     * @@exception ServletException I/O problem reading properties.
     */
    public static void readProperties(String propertiesFile,
                                      Properties theProperties)
        throws IOException
    {
        try
        {
            // Load the properties from the specified file.
            if (propertiesFile.charAt(0) == '/')
            {
                theProperties.load(new BufferedInputStream
                    (new FileInputStream(propertiesFile)));
            }
            else
            {
                // The leading "/" tells Class.getResourceAsStream
                // not to munge the name.
                theProperties.load(new BufferedInputStream
                    (PropertiesUtil.class.getResourceAsStream
                     ("/" + propertiesFile)));
            }
        }
        catch (IOException e)
        {
            Log.error("Unable to read properties file " + propertiesFile, e);
            throw e;
        }
        
        if (DEBUG)
        {
            Log.debug("Properties File: " + propertiesFile);
            for (Enumeration e=theProperties.propertyNames(); 
                 e.hasMoreElements(); )
            {
                String propName = (String) e.nextElement();
                String propValue =
                    (String) theProperties.getProperty(propName);
                Log.debug(propName + " => " + propValue);
            }
        }
    }
}
@
