com.thehellings.config.Config Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of utilities Show documentation
Some simple utilities that I use in my personal Java work
There is a newer version: 1.4
package com.thehellings.config;

import org.ini4j.Ini;

import java.io.InputStream;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Wraps access to the configuration ini file to allow defaults to be processed.
 * 
 *     Pass the constructor the name of the environment/section that is used. It will handle reding the values from the
 *     named section in an ini file. If no such value is found in that section, it will test for a section named
 *     "defaults" and look there for the value instead.
 * 
 */
public class Config {
    private Ini ini;
    private Map section;
    private Map defaults;

    private static final Logger log = Logger.getLogger(Config.class.getName());
    public static final String DEFAULT_SECTION_NAME = "default";

	/**
     * Reads the value of {@link Enum#name()} as the name for the config section
     * @param e
     * @throws Exception
     */
    public Config(final Enum e) throws Exception {
        this(e.name());
    }

    public Config(final String environment) {
        this(environment, Config.class.getResourceAsStream("/config.ini"));
    }

	/**
	 * Reads the value of {@link Enum#name()} as the name for the config section
	 *
	 * @param e
	 * @param stream
	 */
	public Config(final Enum e, InputStream stream) {
		this(e.name(), stream);
	}

	/**
	 *
	 * @param environment
	 * @param stream
	 */
    public Config(final String environment, InputStream stream) {
		try {
			this.ini = new Ini();
			this.ini.load(stream);
			this.section = this.ini.get(environment);
			this.defaults = this.ini.get(DEFAULT_SECTION_NAME);
		} catch(Exception ex) {
			log.log(Level.SEVERE, "Config could not be opened.");
			ex.printStackTrace();
		}
	}

	/**
	 * Get the effective value of a config file entry with the name provided
	 * 
	 *     Looks first in the named section for a value matching that variable. If none is found, it will check in the
	 *     ini section named "defaults". Barring finding an entry there, it will return null.
	 * 
	 *
	 * @param name Name of the variable to find
	 * @return The string value of the variable from the configured section, from the defaults section, or null if not found
	 */
    public String get(final String name) {
        if ( this.section != null && this.section.containsKey(name) ) {
            return this.section.get(name);
        }
        if ( this.defaults != null && this.defaults.containsKey(name) ) {
            return this.defaults.get(name);
        }
        return null;
    }

	/**
	 * Reads the value of {@link Enum#name()} as the field name
	 *
	 * @param e
	 * @return
	 */
    public String get(final Enum e) {
        return this.get(e.name());
    }
}