PropertyUtils.java

package org.apache.maven.shared.utils;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file 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.
 */

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Properties;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.apache.maven.shared.utils.io.IOUtil;

/**
 *
 */
public class PropertyUtils
{

    /**
     * The constructor.
     */
    public PropertyUtils()
    {
        // should throw new IllegalAccessError( "Utility class" );
    }

    /**
     * @param url The URL which should be used to load the properties.
     *
     * @return The loaded properties.
     *
     * @deprecated As of 3.1.0, please use method {@link #loadOptionalProperties(java.net.URL)}. This method should not
     * be used as it suppresses exceptions silently when loading properties fails and returns {@code null} instead of an
     * empty {@code Properties} instance when the given {@code URL} is {@code null}.
     */
    @Deprecated
    public static java.util.Properties loadProperties( @Nonnull URL url )
    {
        try
        {
            return loadProperties( url.openStream() );
        }
        catch ( Exception e )
        {
            // ignore
        }
        return null;
    }

    /**
     * @param file The file from which the properties will be loaded.
     *
     * @return The loaded properties.
     *
     * @deprecated As of 3.1.0, please use method {@link #loadOptionalProperties(java.io.File)}. This method should not
     * be used as it suppresses exceptions silently when loading properties fails and returns {@code null} instead of an
     * empty {@code Properties} instance when the given {@code File} is {@code null}.
     */
    @Deprecated
    public static Properties loadProperties( @Nonnull File file )
    {
        try
        {
            return loadProperties( new FileInputStream( file ) );
        }
        catch ( Exception e )
        {
            // ignore
        }
        return null;
    }

    /**
     * @param is {@link InputStream}
     *
     * @return The loaded properties.
     *
     * @deprecated As of 3.1.0, please use method {@link #loadOptionalProperties(java.io.InputStream)}. This method
     * should not be used as it suppresses exceptions silently when loading properties fails.
     */
    @Deprecated
    public static Properties loadProperties( @Nullable InputStream is )
    {
        try
        {
            // to make this the same behaviour as the others we should really return null on any error
            Properties result = new Properties();
            if ( is != null )
            {
                try
                {
                    result.load( is );
                }
                catch ( IOException e )
                {
                    // ignore
                }
            }
            return result;
        }
        catch ( Exception e )
        {
            // ignore
        }
        finally
        {
            IOUtil.close( is );
        }
        return null;
    }

    /**
     * Loads {@code Properties} from a given {@code URL}.
     * <p>
     * If the given {@code URL} is not {@code null}, it is asserted to represent a valid and loadable properties
     * resource.
     * </p>
     *
     * @param url The {@code URL} of the properties resource to load or {@code null}.
     *
     * @return The loaded properties or an empty {@code Properties} instance if {@code url} is {@code null}.
     *
     * @since 3.1.0
     */
    @Nonnull public static Properties loadOptionalProperties( final @Nullable URL url )
    {
        InputStream in = null;
        try
        {
            final Properties properties = new Properties();

            if ( url != null )
            {
                in = url.openStream();
                properties.load( in );
                in.close();
                in = null;
            }

            return properties;
        }
        catch ( final IOException e )
        {
            throw new AssertionError( e );
        }
        finally
        {
            IOUtil.close( in );
        }
    }

    /**
     * Loads {@code Properties} from a given {@code File}.
     * <p>
     * If the given {@code File} is not {@code null}, it is asserted to represent a valid and loadable properties
     * resource.
     * </p>
     *
     * @param file The {@code File} of the properties resource to load or {@code null}.
     *
     * @return The loaded properties or an empty {@code Properties} instance if {@code file} is {@code null}.
     *
     * @since 3.1.0
     */
    @Nonnull public static Properties loadOptionalProperties( final @Nullable File file )
    {
        InputStream in = null;
        try
        {
            final Properties properties = new Properties();

            if ( file != null )
            {
                in = new FileInputStream( file );
                properties.load( in );
                in.close();
                in = null;
            }

            return properties;
        }
        catch ( final IOException e )
        {
            throw new AssertionError( e );
        }
        finally
        {
            IOUtil.close( in );
        }
    }

    /**
     * Loads {@code Properties} from a given {@code InputStream}.
     * <p>
     * If the given {@code InputStream} is not {@code null}, it is asserted to represent a valid and loadable properties
     * resource.
     * </p>
     *
     * @param inputStream The {@code InputStream} of the properties resource to load or {@code null}.
     *
     * @return The loaded properties or an empty {@code Properties} instance if {@code inputStream} is {@code null}.
     *
     * @since 3.1.0
     */
    @Nonnull public static Properties loadOptionalProperties( final @Nullable InputStream inputStream )
    {
        InputStream in = null;
        try
        {
            final Properties properties = new Properties();

            if ( inputStream != null )
            {
                in = inputStream;
                properties.load( in );
                in.close();
                in = null;
            }

            return properties;
        }
        catch ( final IOException e )
        {
            throw new AssertionError( e );
        }
        finally
        {
            IOUtil.close( in );
        }
    }

}