1 /*
2 * XNap - A P2P framework and client.
3 *
4 * See the file AUTHORS for copyright information.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19
20 package org.xnap.setting;
21
22 /***
23 * Defines the requirements for classes that provide a setting.
24 */
25 public interface Setting
26 {
27
28 //--- Constant(s) ---
29
30 //--- Method(s) ---
31
32 /***
33 * Returns the unique key used that used to identify the setting.
34 */
35 String getKey();
36
37 /***
38 * Sets the value of the setting from s.
39 */
40 void fromString(String s);
41
42 /***
43 * Reverts the setting to its default value.
44 */
45 void revert();
46
47 /***
48 * Returns a string representation of the setting. The string is
49 * written to the settings file.
50 *
51 * @see #fromString(String)
52 */
53 String toString();
54
55 }