org.jpac.configuration.BooleanProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elbfisch.core Show documentation
Open-source runtime system for component-based implementation of automation solutions with Java
The newest version!
/**
 * PROJECT   : Elbfisch - java process automation controller (jPac)
 * MODULE    : BooleanProperty.java
 * VERSION   : -
 * DATE      : -
 * PURPOSE   : 
 * AUTHOR    : Bernd Schuster, MSK Gesellschaft fuer Automatisierung mbH, Schenefeld
 * REMARKS   : -
 * CHANGES   : CH#n   
 *
 * This file is part of the jPac process automation controller.
 * jPac 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.
 *
 * jPac 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 the jPac If not, see .
 */

package org.jpac.configuration;

import org.apache.commons.configuration.ConfigurationException;

/**
 * represents a boolean property stored inside the hierarchical xml configuration file ./cfg/org.jpac.Configuration.xml.
 * if not already present, this property will be automatically stored inside the configuration file on the next save() operation or on exit
 * of the elbfisch application (if property "org.jpac.JPac.StoreConfigOnShutdown = true).
 * If already present, the corresponding entry inside the configuration file is left untouched.
 * @author berndschuster
 */
public class BooleanProperty extends Property{
    /**
     * constructs a boolean property.
     * @param owningObject the module which instantiated this property. All properties owned by a module are stored under its qualified name inside the
     * configuration file.
     * @param key the key under which this property is stored inside the hierarchical xml configuration file.
     * @param defaultValue the value the property earns by default
     * @param comment a comment describing the purpose of the property
     * @param classProperty if true, this property is stored under the name of the modules class, instead of its qualified name. It than can be used by all
     * instances of this module class
     * @throws ConfigurationException thrown, if an error occurs while accessing the configuration 
     */
    public BooleanProperty(Object owningObject, String key, boolean defaultValue, String comment, boolean classProperty) throws ConfigurationException{  
        super(owningObject, key, defaultValue, comment, classProperty);
    }  

    /**
     * constructs an boolean property
     * @param owningObject the module which instantiated this property. All properties owned by a module are stored under its qualified name inside the
     * configuration file.
     * @param key the key under which this property is stored inside the hierarchical xml configuration file.
     * @param defaultValue the value the property earns by default
     * @param comment a comment describing the purpose of the property
     * instances of this module class
     * @throws ConfigurationException thrown, if an error occurs while accessing the configuration 
     */
    public BooleanProperty(Object owningObject, String key, boolean defaultValue, String comment) throws ConfigurationException{  
        super(owningObject, key, defaultValue, comment, false);
    }  

    /**
     * constructs an boolean property
     * @param owningObject the module which instantiated this property. All properties owned by a module are stored under its qualified name inside the
     * configuration file.
     * @param key the key under which this property is stored inside the hierarchical xml configuration file.
     * @param defaultValue the value the property earns by default
     * @param classProperty if true, this property is stored under the name of the modules class, instead of its qualified name. It than can be used by all
     * instances of this module class
     * @throws ConfigurationException thrown, if an error occurs while accessing the configuration 
     */
    public BooleanProperty(Object owningObject, String key, boolean defaultValue, boolean classProperty) throws ConfigurationException{  
        super(owningObject, key, defaultValue, null, classProperty);
    }  

    /**
     * constructs an boolean property
     * @param owningObject the module which instantiated this property. All properties owned by a module are stored under its qualified name inside the
     * configuration file.
     * @param key the key under which this property is stored inside the hierarchical xml configuration file.
     * @param defaultValue the value the property earns by default
     * instances of this module class
     * @throws ConfigurationException thrown, if an error occurs while accessing the configuration 
     */
    public BooleanProperty(Object owningObject, String key, boolean defaultValue) throws ConfigurationException{  
        super(owningObject, key, defaultValue, null, false);
    }  
    
    /**
     * constructs an boolean property for read only access. The key must be fully qualified to access the property
     * @param key the fully qualified key of the property
     * @throws ConfigurationException thrown, if an error occurs while accessing the configuration 
     */
    public BooleanProperty(String key) throws ConfigurationException{  
        super(key);
    }  

    /**
     * returns the value of the property
     * @return the value of the property
     * @throws ConfigurationException thrown, if an error occurs while accessing the configuration 
     */
    public boolean get() throws ConfigurationException{
        touched = true;
        return Configuration.getInstance().getBoolean(key);
    }
    
    /**
     * sets the value of the property
     * @param value the value
     * @throws ConfigurationException thrown, if an error occurs while accessing the configuration 
     */
    public void set(boolean value) throws ConfigurationException{
        touched = true;
        Configuration.getInstance().setProperty(key, value);
    }
}