01: /*
02: * Copyright (C) 2005 Jeff Tassin
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2.1 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */
18:
19: package com.jeta.swingbuilder.interfaces.userprops;
20:
21: /**
22: * This interface describes a service used to store/retrive user properties
23: *
24: * @author Jeff Tassin
25: */
26: public interface TSUserProperties {
27: public static final String COMPONENT_ID = "jeta.TSUserProperties";
28:
29: /**
30: * Reads the named property for the given component from the user properties
31: * store. This method does not throw any exceptions, it is assumed the
32: * implementor will log the exception somewhere
33: *
34: * @param keyName
35: * the unique key name to get the property for
36: * @return the property string. Null is returned if the string is not found
37: */
38: public String getProperty(String keyName);
39:
40: /**
41: * Reads the named property for the given key name from the user properties
42: * store. This method does not throw any exceptions, it is assumed the
43: * implementor will log the exception somewhere
44: *
45: * @param keyName
46: * the unique key name within that component to get the property
47: * for
48: * @param defaultValue
49: * if the key is not found, return this value
50: * @return the property string. Null is returned if the string is not found
51: */
52: public String getProperty(String keyName, String defaultValue);
53:
54: /**
55: * Stores the named property for the given key. This method does not throw
56: * any exceptions, it is assumed the implementor will log the exception
57: * somewhere
58: */
59: public void setProperty(String keyName, String value);
60:
61: }
|