PropertiesUtils.java

/*******************************************************************************
 * Copyright (C) 2013 JMaNGOS <http://jmangos.org/>
 * 
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package org.jmangos.commons.utils;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Collection;
import java.util.Properties;

import org.apache.commons.io.FileUtils;

public class PropertiesUtils {

    /**
     * Loads properties by given file.
     * 
     * @param file
     *        filename
     * @return loaded properties
     * @throws IOException
     *         Signals that an I/O exception has occurred.
     */
    public static Properties load(final String file) throws IOException {

        return load(new File(file));
    }

    /**
     * Loads properties by given file.
     * 
     * @param file
     *        filename
     * @return loaded properties
     * @throws IOException
     *         Signals that an I/O exception has occurred.
     */
    public static Properties load(final File file) throws IOException {

        FileInputStream fis = null;
        try {
            fis = new FileInputStream(file);
            final Properties p = new Properties();
            p.load(fis);
            return p;
        } finally {
            if (fis != null) {
                fis.close();
            }
        }
    }

    /**
     * Loads properties from given files.
     * 
     * @param files
     *        list of string that represents files
     * @return array of loaded properties
     * @throws IOException
     *         if was unable to read properties
     */
    public static Properties[] load(final String... files) throws IOException {

        final Properties[] result = new Properties[files.length];
        for (int i = 0; i < result.length; i++) {
            result[i] = load(files[i]);
        }
        return result;
    }

    /**
     * Loades properties from given files.
     * 
     * @param files
     *        list of files
     * @return array of loaded properties
     * @throws IOException
     *         if was unable to read properties
     */
    public static Properties[] load(final File... files) throws IOException {

        final Properties[] result = new Properties[files.length];
        for (int i = 0; i < result.length; i++) {
            result[i] = load(files[i]);
        }
        return result;
    }

    /**
     * Loads non-recursively all .property files form directory
     * 
     * @param dir
     *        string that represents directory
     * @return array of loaded properties
     * @throws IOException
     *         if was unable to read properties
     */
    public static Properties[] loadAllFromDirectory(final String dir) throws IOException {

        return loadAllFromDirectory(new File(dir), false);
    }

    /**
     * Loads non-recursively all .property files form directory
     * 
     * @param dir
     *        directory
     * @return array of loaded properties
     * @throws IOException
     *         if was unable to read properties
     */
    public static Properties[] loadAllFromDirectory(final File dir) throws IOException {

        return loadAllFromDirectory(dir, false);
    }

    /**
     * Loads all .property files form directory
     * 
     * @param dir
     *        string that represents directory
     * @param recursive
     *        parse subdirectories or not
     * @return array of loaded properties
     * @throws IOException
     *         if was unable to read properties
     */
    public static Properties[] loadAllFromDirectory(final String dir, final boolean recursive)
            throws IOException {

        return loadAllFromDirectory(new File(dir), recursive);
    }

    /**
     * Loads all .property files form directory
     * 
     * @param dir
     *        directory
     * @param recursive
     *        parse subdirectories or not
     * @return array of loaded properties
     * @throws IOException
     *         if was unable to read properties
     */
    public static Properties[] loadAllFromDirectory(final File dir, final boolean recursive)
            throws IOException {

        final Collection<File> files =
                FileUtils.listFiles(dir, new String[] { "properties" }, recursive);
        return load(files.toArray(new File[files.size()]));
    }
}