/*
 *   JSampler - a java front-end for LinuxSampler
 *
 *   Copyright (C) 2005-2007 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   This file is part of JSampler.
 *
 *   JSampler is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   JSampler 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 JSampler; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.jsampler;

import java.beans.PropertyChangeSupport;
import java.util.prefs.Preferences;

/**
 *
 * @author Grigor Iliev
 */
public class JSPrefs extends PropertyChangeSupport {
	private final String pathName;
	private final Preferences userPrefs;
	
	/**
	 * Creates a new instance of <code>JSPrefs</code>.
	 * @param pathName The path name of the preferences node.
	 */
	public
	JSPrefs(String pathName) {
		super(new Object());
		
		this.pathName = pathName;
		userPrefs = Preferences.userRoot().node(pathName);
	}
	
	private Preferences
	user() { return userPrefs; }
	
	/**
	 * Gets a string property.
	 * @param name The name of the property.
	 * @return The value of the specified property.
	 * If the property is not set, the return value is <code>null</code>.
	 * @see #getDefaultStringValue
	 */
	public String
	getStringProperty(String name) {
		return getStringProperty(name, getDefaultStringValue(name));
	}
	
	/**
	 * Gets a string property.
	 * @param name The name of the property.
	 * @param defaultValue The value to return if the property is not set.
	 * @return The value of the specified property.
	 */
	public String
	getStringProperty(String name, String defaultValue) {
		return user().get(name, defaultValue);
	}
	
	/**
	 * Sets an integer property.
	 * @param name The name of the property.
	 * @param i The new value for the specified property.
	 */
	public void
	setStringProperty(String name, String s) {
		String oldValue = getStringProperty(name);
		
		if(s == null) user().remove(name);
		else user().put(name, s);
		
		firePropertyChange(name, oldValue, s);
	}
	
	/**
	 * Gets the default value for the specified property.
	 * The default value is used when the property is not set.
	 * Override this method to provide custom default values for specific properties.
	 * @name The name of the property whose default value should be obtained.
	 * @return <code>null</code>
	 * @see #getStringProperty(String name)
	 */
	public String
	getDefaultStringValue(String name) { return null; }
	
	/**
	 * Gets an integer property.
	 * @param name The name of the property.
	 * @return The value of the specified property.
	 * @see #getDefaultIntValue
	 */
	public int
	getIntProperty(String name) {
		return getIntProperty(name, getDefaultIntValue(name));
	}
	
	/**
	 * Gets an integer property.
	 * @param name The name of the property.
	 * @param defaultValue The value to return if the property is not set.
	 * @return The value of the specified property.
	 */
	public int
	getIntProperty(String name, int defaultValue) {
		return user().getInt(name, defaultValue);
	}
	
	/**
	 * Gets the default value for the specified property.
	 * The default value is used when the property is not set.
	 * Override this method to provide custom default values for specific properties.
	 * @name The name of the property whose default value should be obtained.
	 * @return <code>0</code>
	 * @see #getIntProperty(String name)
	 */
	public int
	getDefaultIntValue(String name) { return 0; }
	
	/**
	 * Sets an integer property.
	 * @param name The name of the property.
	 * @param i The new value for the specified property.
	 */
	public void
	setIntProperty(String name, int i) {
		int oldValue = getIntProperty(name);
		user().putInt(name, i);
		firePropertyChange(name, oldValue, i);
	}
	
	
	/**
	 * Gets a boolean property.
	 * @param name The name of the property.
	 * @return The value of the specified property.
	 * @see #getDefaultBoolValue
	 */
	public boolean
	getBoolProperty(String name) {
		return getBoolProperty(name, getDefaultBoolValue(name));
	}
	/**
	 * Gets a boolean property.
	 * @param name The name of the property.
	 * @param defaultValue The value to return if the property is not set.
	 * @return The value of the specified property.
	 */
	public boolean
	getBoolProperty(String name, boolean defaultValue) {
		return user().getBoolean(name, defaultValue);
	}
	
	/**
	 * Sets a boolean property.
	 * @param name The name of the property.
	 * @param b The new value for the specified property.
	 */
	public void
	setBoolProperty(String name, boolean b) {
		boolean oldValue = getBoolProperty(name);
		user().putBoolean(name, b);
		firePropertyChange(name, oldValue, b);
	}
	
	/**
	 * Gets the default value for the specified property.
	 * The default value is used when the property is not set.
	 * Override this method to provide custom default values for specific properties.
	 * @name The name of the property whose default value should be obtained.
	 * @return <code>false</code>
	 * @see #getBoolProperty(String name)
	 */
	public boolean
	getDefaultBoolValue(String name) { return false; }
}