Properties - Revision history

Hall at 17:41, 28 November 2006

2006-11-28T17:41:19Z

Watkinson at 21:24, 20 November 2006

2006-11-20T21:24:59Z

Watkinson at 22:02, 12 October 2006

2006-10-12T22:02:11Z

Watkinson at 21:55, 12 October 2006

2006-10-12T21:55:44Z

Watkinson at 21:52, 12 October 2006

2006-10-12T21:52:36Z

New page

Components often want to store and retrieve configuration settings between invocations. An API is provided for this purpose.

Configuration is handled by the setting and getting of properties using the

@@ Line 1: / Line 1: @@
 Components often want to store and retrieve configuration settings between invocations. An API is provided for this purpose.
-Configuration is handled by the setting and getting of properties using the [{{SERVER}}/workbench/api/org/geworkbench/engine/properties/PropertyManager.html <tt>org.geworkbench.engine.properties.PropertyManager</tt>] class. A singleton instance is available to process requests.
+Configuration is handled by the setting and getting of properties using the [{{SERVER}}/workbench/api/org/geworkbench/engine/properties/PropertiesManager.html <tt>org.geworkbench.engine.properties.PropertiesManager</tt>] class. A singleton instance is available to process requests.
 The two important methods of this class are:

@@ Line 12: / Line 12: @@
 </pre>
-The first parameter to both methods can be the <code>Class</code> object of any class in your component. This is used to determine where the configuration will be stored. The <code>defaultValue</code> parameter of <code>getProperty</code> will be the returned result if there is no known value for the specified key.
+The first parameter to both methods can be the <code>Class</code> object of any class in your component. This is used to determine where the configuration will be stored. This class is mapped back to the component that it is associated with. The <code>defaultValue</code> parameter of <code>getProperty</code> will be the returned result if there is no known value for the specified key.
 Here is an example use of the properties manager:

@@ Line 5: / Line 5: @@
 The two important methods of this class are:
 <pre>
-public void setProperty(Class component, String key, String value) throws IOException
+public void setProperty(Class componentClass, String key, String value) throws IOException;
 </pre>
 and
 <pre>
-public String getProperty(Class component, String key, String defaultValue) throws IOException
+public String getProperty(Class componentClass, String key, String defaultValue) throws IOException;
 </pre>

← Older revision		Revision as of 21:55, 12 October 2006
Line 1:		Line 1:
	Components often want to store and retrieve configuration settings between invocations. An API is provided for this purpose.		Components often want to store and retrieve configuration settings between invocations. An API is provided for this purpose.

−	Configuration is handled by the setting and getting of properties using the	+	Configuration is handled by the setting and getting of properties using the [{{SERVER}}/workbench/api/org/geworkbench/engine/properties/PropertyManager.html <tt>org.geworkbench.engine.properties.PropertyManager</tt>] class. A singleton instance is available to process requests.
		+
		+	The two important methods of this class are:
		+	<pre>
		+	public void setProperty(Class component, String key, String value) throws IOException
		+	</pre>
		+	and
		+	<pre>
		+	public String getProperty(Class component, String key, String defaultValue) throws IOException
		+	</pre>