org.openbp.common.setting.FixedSettingProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openbp-common Show documentation

Common base for all OpenBP projects

There is a newer version: 0.9.11

/*
 *   Licensed 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.
 */
package org.openbp.common.setting;

import java.util.HashMap;
import java.util.Map;

import org.openbp.common.util.ToStringHelper;

/**
 * Implementation of a setting provider that supports access to System properties.
 * The returned setting values are always strings.
 *
 * @author Heiko Erhardt
 */
public final class FixedSettingProvider
	implements SettingProvider
{
	/** Settings */
	private Map settings = new HashMap();

	/**
	 * Constructor.
	 */
	public FixedSettingProvider()
	{
	}

	public String toString()
	{
		return ToStringHelper.toString(this, "settings");
	}

	/**
	 * Defines a new setting.
	 *
	 * @param name Name of the setting
	 * @param value The setting value
	 */
	public void define(String name, Object value)
	{
		settings.put(name, value);
	}

	//////////////////////////////////////////////////
	// @@ Setting access
	//////////////////////////////////////////////////

	/**
	 * Gets a setting value.
	 *
	 * @param name Name of the setting
	 * @return The setting value or null if the setting does not exist
	 */
	public Object getSetting(String name)
	{
		return settings.get(name);
	}

	/**
	 * Sets a setting.
	 * Fixed properties cannot be saved, so the method returns always false.
	 *
	 * @param name Name of the setting
	 * @param value Value of the setting
	 * @return false
	 */
	public boolean setSetting(String name, Object value)
	{
		return false;
	}

	/**
	 * Loads the settings.
	 * Does nothing.
	 *
	 * @return true
	 */
	public boolean loadSettings()
	{
		return true;
	}

	/**
	 * Saves the settings.
	 * Does nothing.
	 *
	 * @return true
	 */
	public boolean saveSettings()
	{
		return true;
	}

	/**
	 * Gets the settings.
	 */
	public Map getSettings()
	{
		return settings;
	}

	/**
	 * Sets the settings.
	 */
	public void setSettings(Map settings)
	{
		this.settings = settings;
	}
}