KeyedSettingSpecifier.java

/* ==================================================================
 * KeyedSettingSpecifier.java - Mar 12, 2012 9:28:55 AM
 * 
 * Copyright 2007-2012 SolarNetwork.net Dev Team
 * 
 * This program 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 2 of 
 * the License, or (at your option) any later version.
 * 
 * This program 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 this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 */

package net.solarnetwork.node.settings;

/**
 * A setting specifier that can store a value associated with a key.
 * 
 * @param <T>
 *        the type of value stored by this setting
 * @author matt
 * @version 1.3
 */
public interface KeyedSettingSpecifier<T> extends SettingSpecifier, MappableSpecifier {

	/**
	 * Get the key for this setting.
	 * 
	 * @return the key to associate with this setting
	 */
	String getKey();

	/**
	 * Get the default value for this setting.
	 * 
	 * @return the default value
	 */
	T getDefaultValue();

	/**
	 * Return a setting specifier mapped to a new path, using a {@link Mapper}.
	 * 
	 * @param mapper
	 *        the mapper
	 * @return the new instance
	 * @deprecated Use
	 *             {@link MappableSpecifier#mappedWithMapper(net.solarnetwork.node.settings.MappableSpecifier.Mapper)}
	 *             directly.
	 */
	@Deprecated
	SettingSpecifier mappedWithMapper(Mapper mapper);

	/**
	 * Get transient flag.
	 * 
	 * <p>
	 * If a setting is transient, its associated value is never actually
	 * persisted and the {@link #getDefaultValue()} is treated as its "current"
	 * value. This can be used for
	 * 
	 * @return
	 */
	boolean isTransient();

	/**
	 * API to dynamically map a key to a new key.
	 * 
	 * @deprecated Use {@link MappableSpecifier.Mapper} directly.
	 */
	@Deprecated
	interface Mapper extends MappableSpecifier.Mapper {
		// nothing added
	}

	/**
	 * Get an optional list of message arguments to use when rendering a
	 * description of this specifier.
	 * 
	 * @return An optional list of message arguments.
	 * @since 1.3
	 */
	Object[] getDescriptionArguments();
}