View Javadoc

1   /*
2    *  XNap Commons
3    *
4    *  Copyright (C) 2005  Steffen Pingel
5    *
6    *  This library is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU Lesser General Public
8    *  License as published by the Free Software Foundation; either
9    *  version 2.1 of the License, or (at your option) any later version.
10   *
11   *  This library is distributed in the hope that it will be useful,
12   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   *  Lesser General Public License for more details.
15   *
16   *  You should have received a copy of the GNU Lesser General Public
17   *  License along with this library; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package org.xnap.commons.settings;
21  
22  /***
23   * Defines the requirements for classes that provide a setting.
24   */
25  public interface Setting<T>
26  {
27  
28  	T getDefaultValue();
29  	
30  	/***
31  	 * Returns the unique key used that used to identify the setting.
32  	 */
33  	String getKey();
34  
35  	T getValue();
36  	
37  	/***
38  	 * Reverts the setting to its default value.
39  	 */
40  	void revert();
41  
42  	void setValue(T newValue);
43  	
44  }