diff options
Diffstat (limited to 'javadoc/shared/Config.html')
| -rw-r--r-- | javadoc/shared/Config.html | 491 |
1 files changed, 491 insertions, 0 deletions
diff --git a/javadoc/shared/Config.html b/javadoc/shared/Config.html new file mode 100644 index 0000000..0c4e88e --- /dev/null +++ b/javadoc/shared/Config.html @@ -0,0 +1,491 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.4.2-p8) on Sat Apr 29 14:43:47 CEST 2006 --> +<TITLE> +Config +</TITLE> + +<META NAME="keywords" CONTENT="shared.Config class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="Config"; +} +</SCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Config.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../shared/CalendarEvent.html" title="class in shared"><B>PREV CLASS</B></A> + <A HREF="../shared/Main.html" title="class in shared"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="Config.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +shared</FONT> +<BR> +Class Config</H2> +<PRE> +java.lang.Object + <IMG SRC="../resources/inherit.gif" ALT="extended by"><B>shared.Config</B> +</PRE> +<HR> +<DL> +<DT>public final class <B>Config</B><DT>extends java.lang.Object</DL> + +<P> +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. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>buetow</DD> +</DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#VERSION">VERSION</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../shared/Config.html#Config()">Config</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#getBooleanValue(java.lang.String)">getBooleanValue</A></B>(java.lang.String sKey)</CODE> + +<BR> + This method returns a specific boolean config value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#getIntValue(java.lang.String)">getIntValue</A></B>(java.lang.String sKey)</CODE> + +<BR> + This method returns a specific integer config value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.util.Set</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#getKeySet()">getKeySet</A></B>()</CODE> + +<BR> + This method returns a set of keys of the config hash map.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.net.InetAddress</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#getServerAddress()">getServerAddress</A></B>()</CODE> + +<BR> + This method returns the inet address of the calendar server.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#getSortedKeyArray()">getSortedKeyArray</A></B>()</CODE> + +<BR> + This method returns a sorted String array of all available config keys.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#getStringValue(java.lang.String)">getStringValue</A></B>(java.lang.String sKey)</CODE> + +<BR> + This method returns a specific string config value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#initialize(java.lang.String[])">initialize</A></B>(java.lang.String[] args)</CODE> + +<BR> + Initializes all the config values.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#readConfig(java.lang.String)">readConfig</A></B>(java.lang.String sConfigFile)</CODE> + +<BR> + This methods reads the options from the calendar config file 'config.txt'.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#setValue(java.lang.String, java.lang.String)">setValue</A></B>(java.lang.String sKey, + java.lang.String sVal)</CODE> + +<BR> + This method changes or adds a specific config value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../shared/Config.html#writeConfigToFile()">writeConfigToFile</A></B>()</CODE> + +<BR> + This method writes the current configuration to the config file "config.txt".</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="VERSION"><!-- --></A><H3> +VERSION</H3> +<PRE> +public static final java.lang.String <B>VERSION</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#shared.Config.VERSION">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="Config()"><!-- --></A><H3> +Config</H3> +<PRE> +public <B>Config</B>()</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="initialize(java.lang.String[])"><!-- --></A><H3> +initialize</H3> +<PRE> +public static void <B>initialize</B>(java.lang.String[] args)</PRE> +<DL> +<DD>Initializes all the config values. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>args</CODE> - The start parameters.</DL> +</DD> +</DL> +<HR> + +<A NAME="readConfig(java.lang.String)"><!-- --></A><H3> +readConfig</H3> +<PRE> +public static void <B>readConfig</B>(java.lang.String sConfigFile)</PRE> +<DL> +<DD>This methods reads the options from the calendar config file 'config.txt'. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sConfigFile</CODE> - Specifies the relative or absolute path to the config file.</DL> +</DD> +</DL> +<HR> + +<A NAME="getServerAddress()"><!-- --></A><H3> +getServerAddress</H3> +<PRE> +public static java.net.InetAddress <B>getServerAddress</B>()</PRE> +<DL> +<DD>This method returns the inet address of the calendar server. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the calendar server's address .</DL> +</DD> +</DL> +<HR> + +<A NAME="getStringValue(java.lang.String)"><!-- --></A><H3> +getStringValue</H3> +<PRE> +public static java.lang.String <B>getStringValue</B>(java.lang.String sKey)</PRE> +<DL> +<DD>This method returns a specific string config value. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sKey</CODE> - Specifies the key of the config value to return. +<DT><B>Returns:</B><DD>Returns the requested config value.</DL> +</DD> +</DL> +<HR> + +<A NAME="getIntValue(java.lang.String)"><!-- --></A><H3> +getIntValue</H3> +<PRE> +public static int <B>getIntValue</B>(java.lang.String sKey)</PRE> +<DL> +<DD>This method returns a specific integer config value. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sKey</CODE> - Specifies the key of the config value to return. +<DT><B>Returns:</B><DD>Returns the requested config value.</DL> +</DD> +</DL> +<HR> + +<A NAME="getBooleanValue(java.lang.String)"><!-- --></A><H3> +getBooleanValue</H3> +<PRE> +public static boolean <B>getBooleanValue</B>(java.lang.String sKey)</PRE> +<DL> +<DD>This method returns a specific boolean config value. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sKey</CODE> - Specifies the key of the config value to return. +<DT><B>Returns:</B><DD>Returns the requested config value.</DL> +</DD> +</DL> +<HR> + +<A NAME="getKeySet()"><!-- --></A><H3> +getKeySet</H3> +<PRE> +public static java.util.Set <B>getKeySet</B>()</PRE> +<DL> +<DD>This method returns a set of keys of the config hash map. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns a Set object containing all keys of the Config's hash map.</DL> +</DD> +</DL> +<HR> + +<A NAME="setValue(java.lang.String, java.lang.String)"><!-- --></A><H3> +setValue</H3> +<PRE> +public static void <B>setValue</B>(java.lang.String sKey, + java.lang.String sVal)</PRE> +<DL> +<DD>This method changes or adds a specific config value. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>sKey</CODE> - Specifies the config key to set or update.<DD><CODE>sVal</CODE> - Specifies the value of the key to set or update.</DL> +</DD> +</DL> +<HR> + +<A NAME="getSortedKeyArray()"><!-- --></A><H3> +getSortedKeyArray</H3> +<PRE> +public static java.lang.String[] <B>getSortedKeyArray</B>()</PRE> +<DL> +<DD>This method returns a sorted String array of all available config keys. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns a sorted String array of all available config keys.</DL> +</DD> +</DL> +<HR> + +<A NAME="writeConfigToFile()"><!-- --></A><H3> +writeConfigToFile</H3> +<PRE> +public static void <B>writeConfigToFile</B>()</PRE> +<DL> +<DD>This method writes the current configuration to the config file "config.txt". +<P> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Config.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../shared/CalendarEvent.html" title="class in shared"><B>PREV CLASS</B></A> + <A HREF="../shared/Main.html" title="class in shared"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="Config.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |