/**
 * Redistribution and use of this software and associated documentation
 * ("Software"), with or without modification, are permitted provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain copyright
 *    statements and notices.  Redistributions must also contain a
 *    copy of this document.
 *
 * 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 name "Exolab" must not be used to endorse or promote
 *    products derived from this Software without prior written
 *    permission of Exoffice Technologies.  For written permission,
 *    please contact info@exolab.org.
 *
 * 4. Products derived from this Software may not be called "Exolab"
 *    nor may "Exolab" appear in their names without prior written
 *    permission of Exoffice Technologies. Exolab is a registered
 *    trademark of Exoffice Technologies.
 *
 * 5. Due credit should be given to the Exolab Project
 *    (http://www.exolab.org/).
 *
 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
 * ``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
 * EXOFFICE TECHNOLOGIES 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.
 *
 * Copyright 1999 (C) Exoffice Technologies Inc. All Rights Reserved.
 *
 * $Id: SafeProperties.java,v 1.2 2002/02/25 20:31:01 dblevins Exp $
 */
package org.openejb.util;

import java.util.Properties;
import org.openejb.OpenEJBException;

public class SafeProperties{

    private String systemLocation;
    private Properties props;

    /**
     * Creates a new SafeProperties usign the Properties object passed in.
     *
     * @throws OpenEJBExcption if the properties object passed in is null.
     */
    public SafeProperties(Properties props, String systemLocation) throws OpenEJBException{
        if (props == null) OpenEJBErrorHandler.propertiesObjectIsNull(systemLocation);
        this.props = props;
        this.systemLocation = systemLocation;
    }

    /**
     * Returns the value of the key.
     *
     * @throws OpenEJBException if the property does not exist or is null.
     */
    public String getProperty(String key) throws OpenEJBException{
        String value = props.getProperty(key);
        if (value == null)OpenEJBErrorHandler.propertyNotFound(key, systemLocation+ " properties object");
        return value;
    }
    /**
     * Returns the value of the key.
     *
     * @throws OpenEJBException if the property does not exist or is null.
     */
    public String getProperty(String key, String defaultValue) throws OpenEJBException{
        String value = props.getProperty(key);
        if (value == null) 
            return defaultValue;
        else
            return value;
    }

    /**
     * Returns the value of the key as an int.
     *
     * @throws OpenEJBException if the property does not exist, is null, or cannot be converted to an int.
     */
    public int getPropertyAsInt(String key) throws OpenEJBException{
        int integer = 0;
        String value = getProperty(key);
        try{
            integer = Integer.parseInt(value);
        }
        catch(NumberFormatException nfe){
            OpenEJBErrorHandler.propertyValueIsIllegal(key, value);
        }
        return integer;
    }
    /**
     * Returns the value of the key as an int.
     *
     * @throws OpenEJBException if the property does not exist, is null, or cannot be converted to an int.
     */
    public int getPropertyAsInt(String key, int defaultValue) throws OpenEJBException{
        int integer = defaultValue;
        String value = getProperty(key,String.valueOf(defaultValue));
        try{
            integer = Integer.parseInt(value);
        }
        catch(NumberFormatException nfe){
            OpenEJBErrorHandler.propertyValueIsIllegal(key, value);
        }
        return integer;
    }
    /**
     * Returns the value of the key as an Integer.
     *
     * @throws OpenEJBException if the property does not exist, is null, or cannot be converted to an Integer.
     */
    public Integer getPropertyAsInteger(String key, Integer defaultValue) throws OpenEJBException{
        Integer integer = null;
        String value = getProperty(key,defaultValue.toString());
        try{
            integer = new Integer(value);
        }
        catch(NumberFormatException nfe){
            OpenEJBErrorHandler.propertyValueIsIllegal(key, value);
        }
        return integer;
    }
    /**
     * Returns the value of the key as an Integer.
     *
     * @throws OpenEJBException if the property does not exist, is null, or cannot be converted to an Integer.
     */
    public Integer getPropertyAsInteger(String key) throws OpenEJBException{
        Integer integer = null;
        String value = getProperty(key);
        try{
            integer = new Integer(value);
        }
        catch(NumberFormatException nfe){
            OpenEJBErrorHandler.propertyValueIsIllegal(key, value);
        }
        return integer;
    }
    /**
     * Returns the value of the key as an boolean.
     *
     */
    public boolean getPropertyAsBoolean(String key) throws OpenEJBException{
        Integer integer = null;
        String value = getProperty(key);
        return new Boolean(value).booleanValue();
    }
    /**
     * Returns the value of the key as an boolean.
     *
     */
    public Boolean getPropertyAsBoolean(String key, Boolean defaultValue) throws OpenEJBException{
        Integer integer = null;
        String value = getProperty(key, defaultValue.toString());
        return new Boolean(value);
    }

}