co.turnus.generic.AbstractConfigurable.java Source code

Introduction

Here is the source code for co.turnus.generic.AbstractConfigurable.java

Source

/* 
 * TURNUS, the co-exploration framework
 * 
 * Copyright (C) 2014 EPFL SCI STI MM
 *
 * This file is part of TURNUS.
 *
 * TURNUS 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 3 of the License, or
 * (at your option) any later version.
 *
 * TURNUS 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 TURNUS.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Additional permission under GNU GPL version 3 section 7
 * 
 * If you modify this Program, or any covered work, by linking or combining it
 * with Eclipse (or a modified version of Eclipse or an Eclipse plugin or 
 * an Eclipse library), containing parts covered by the terms of the 
 * Eclipse Public License (EPL), the licensors of this Program grant you 
 * additional permission to convey the resulting work.  Corresponding Source 
 * for a non-source form of such a combination shall include the source code 
 * for the parts of Eclipse libraries used as well as that of the  covered work.
 * 
 */
package co.turnus.generic;

import java.io.File;

import org.apache.commons.configuration.BaseConfiguration;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.ConfigurationUtils;
import org.apache.commons.configuration.XMLConfiguration;

import co.turnus.TurnusRuntimeException;

public class AbstractConfigurable implements Configurable {

    private Configuration configuration;

    protected Configuration getConfiguration() {
        Configuration c = configuration != null ? configuration : new BaseConfiguration();
        return ConfigurationUtils.cloneConfiguration(c);
    }

    @SuppressWarnings("unchecked")
    protected <T> T getOption(String name) {
        if (configuration != null) {
            return (T) configuration.getProperty(name);
        } else {
            return null;
        }
    }

    protected <T> T getOption(String name, T defaultValue) {
        T value = getOption(name);
        return value != null ? value : defaultValue;
    }

    protected boolean hasOption(String name) {
        return configuration.containsKey(name);
    }

    protected void loadConfiguration(File file) {
        try {
            configuration = new XMLConfiguration(file);
        } catch (ConfigurationException e) {
            throw new TurnusRuntimeException("Error while loading the configuration to " + file.getAbsolutePath());
        }
    }

    @Override
    public void setConfiguration(Configuration configuration) {
        this.configuration = ConfigurationUtils.cloneConfiguration(configuration);
    }

    protected void setOption(String name, Object value) {
        if (configuration == null) {
            configuration = new BaseConfiguration();
        }
        configuration.setProperty(name, value);
    }

    protected void storeConfiguration(File file) {
        XMLConfiguration xml = new XMLConfiguration();
        xml.copy(configuration);
        try {
            xml.save(file);
        } catch (Exception e) {
            throw new TurnusRuntimeException("Error while storing the configuration to " + file.getAbsolutePath());
        }
    }

}