From 0031991fad54c376b742b1a425531345638cbf57 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sat, 7 Feb 2009 11:29:36 +0000 Subject: initial import into svn --- doc/shared/Config.html | 491 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 491 insertions(+) create mode 100644 doc/shared/Config.html (limited to 'doc/shared/Config.html') diff --git a/doc/shared/Config.html b/doc/shared/Config.html new file mode 100644 index 0000000..0c4e88e --- /dev/null +++ b/doc/shared/Config.html @@ -0,0 +1,491 @@ + + + + + + +Config + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +shared +
+Class Config

+
+java.lang.Object
+  extended byshared.Config
+
+
+
+
public final class Config
extends java.lang.Object
+ +

+This class makes all the configuration options available to all the other classes and objects + of this program. Its reading and writing back the values from and to the config.txt file. +

+ +

+

+
Author:
+
buetow
+
+
+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringVERSION + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Config() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static booleangetBooleanValue(java.lang.String sKey) + +
+          This method returns a specific boolean config value.
+static intgetIntValue(java.lang.String sKey) + +
+          This method returns a specific integer config value.
+static java.util.SetgetKeySet() + +
+          This method returns a set of keys of the config hash map.
+static java.net.InetAddressgetServerAddress() + +
+          This method returns the inet address of the calendar server.
+static java.lang.String[]getSortedKeyArray() + +
+          This method returns a sorted String array of all available config keys.
+static java.lang.StringgetStringValue(java.lang.String sKey) + +
+          This method returns a specific string config value.
+static voidinitialize(java.lang.String[] args) + +
+          Initializes all the config values.
+static voidreadConfig(java.lang.String sConfigFile) + +
+          This methods reads the options from the calendar config file 'config.txt'.
+static voidsetValue(java.lang.String sKey, + java.lang.String sVal) + +
+          This method changes or adds a specific config value.
+static voidwriteConfigToFile() + +
+          This method writes the current configuration to the config file "config.txt".
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+VERSION

+
+public static final java.lang.String VERSION
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+Config

+
+public Config()
+
+
+ + + + + + + + +
+Method Detail
+ +

+initialize

+
+public static void initialize(java.lang.String[] args)
+
+
Initializes all the config values. +

+

+
Parameters:
args - The start parameters.
+
+
+
+ +

+readConfig

+
+public static void readConfig(java.lang.String sConfigFile)
+
+
This methods reads the options from the calendar config file 'config.txt'. +

+

+
Parameters:
sConfigFile - Specifies the relative or absolute path to the config file.
+
+
+
+ +

+getServerAddress

+
+public static java.net.InetAddress getServerAddress()
+
+
This method returns the inet address of the calendar server. +

+

+ +
Returns:
Returns the calendar server's address .
+
+
+
+ +

+getStringValue

+
+public static java.lang.String getStringValue(java.lang.String sKey)
+
+
This method returns a specific string config value. +

+

+
Parameters:
sKey - Specifies the key of the config value to return. +
Returns:
Returns the requested config value.
+
+
+
+ +

+getIntValue

+
+public static int getIntValue(java.lang.String sKey)
+
+
This method returns a specific integer config value. +

+

+
Parameters:
sKey - Specifies the key of the config value to return. +
Returns:
Returns the requested config value.
+
+
+
+ +

+getBooleanValue

+
+public static boolean getBooleanValue(java.lang.String sKey)
+
+
This method returns a specific boolean config value. +

+

+
Parameters:
sKey - Specifies the key of the config value to return. +
Returns:
Returns the requested config value.
+
+
+
+ +

+getKeySet

+
+public static java.util.Set getKeySet()
+
+
This method returns a set of keys of the config hash map. +

+

+ +
Returns:
Returns a Set object containing all keys of the Config's hash map.
+
+
+
+ +

+setValue

+
+public static void setValue(java.lang.String sKey,
+                            java.lang.String sVal)
+
+
This method changes or adds a specific config value. +

+

+
Parameters:
sKey - Specifies the config key to set or update.
sVal - Specifies the value of the key to set or update.
+
+
+
+ +

+getSortedKeyArray

+
+public static java.lang.String[] getSortedKeyArray()
+
+
This method returns a sorted String array of all available config keys. +

+

+ +
Returns:
Returns a sorted String array of all available config keys.
+
+
+
+ +

+writeConfigToFile

+
+public static void writeConfigToFile()
+
+
This method writes the current configuration to the config file "config.txt". +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + -- cgit v1.2.3