jiveglobals.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

<DT><B>Returns:</B><DD>a String representing the time.</DL>
</DD>
</DL>
<HR>

<A NAME="formatDate(java.util.Date)"><!-- --></A><H3>
formatDate</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>formatDate</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A>&nbsp;date)</PRE>
<DL>
<DD>Formats a Date object to return a date using the global locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - the Date to format.
<DT><B>Returns:</B><DD>a String representing the date.</DL>
</DD>
</DL>
<HR>

<A NAME="formatDateTime(java.util.Date)"><!-- --></A><H3>
formatDateTime</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>formatDateTime</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A>&nbsp;date)</PRE>
<DL>
<DD>Formats a Date object to return a date and time using the global locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - the Date to format.
<DT><B>Returns:</B><DD>a String representing the date and time.</DL>
</DD>
</DL>
<HR>

<A NAME="getHomeDirectory()"><!-- --></A><H3>
getHomeDirectory</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getHomeDirectory</B>()</PRE>
<DL>
<DD>Returns the location of the <code>home</code> directory.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the location of the home dir.</DL>
</DD>
</DL>
<HR>

<A NAME="setHomeDirectory(java.lang.String)"><!-- --></A><H3>
setHomeDirectory</H3>
<PRE>
public static void <B>setHomeDirectory</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pathname)</PRE>
<DL>
<DD>Sets the location of the <code>home</code> directory. The directory must exist and the
 user running the application must have read and write permissions over the specified
 directory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pathname</CODE> - the location of the home dir.</DL>
</DD>
</DL>
<HR>

<A NAME="getXMLProperty(java.lang.String)"><!-- --></A><H3>
getXMLProperty</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getXMLProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Returns a local property. Local properties are stored in the file defined in
 <tt>JIVE_CONFIG_FILENAME</tt> that exists in the <tt>home</tt> directory.
 Properties are always specified as "foo.bar.prop", which would map to
 the following entry in the XML file:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to return.
<DT><B>Returns:</B><DD>the property value specified by name.</DL>
</DD>
</DL>
<HR>

<A NAME="getXMLProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
getXMLProperty</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getXMLProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                                    <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;defaultValue)</PRE>
<DL>
<DD>Returns a local property. Local properties are stored in the file defined in
 <tt>JIVE_CONFIG_FILENAME</tt> that exists in the <tt>home</tt> directory.
 Properties are always specified as "foo.bar.prop", which would map to
 the following entry in the XML file:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>

 If the specified property can't be found, the <tt>defaultValue</tt> will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to return.<DD><CODE>defaultValue</CODE> - the default value for the property.
<DT><B>Returns:</B><DD>the property value specified by name.</DL>
</DD>
</DL>
<HR>

<A NAME="getXMLProperty(java.lang.String, int)"><!-- --></A><H3>
getXMLProperty</H3>
<PRE>
public static int <B>getXMLProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                                 int&nbsp;defaultValue)</PRE>
<DL>
<DD>Returns an integer value local property. Local properties are stored in the file defined in
 <tt>JIVE_CONFIG_FILENAME</tt> that exists in the <tt>home</tt> directory.
 Properties are always specified as "foo.bar.prop", which would map to
 the following entry in the XML file:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>

 If the specified property can't be found, or if the value is not a number, the
 <tt>defaultValue</tt> will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to return.<DD><CODE>defaultValue</CODE> - value returned if the property could not be loaded or was not
      a number.
<DT><B>Returns:</B><DD>the property value specified by name or <tt>defaultValue</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="getXMLProperty(java.lang.String, boolean)"><!-- --></A><H3>
getXMLProperty</H3>
<PRE>
public static boolean <B>getXMLProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                                     boolean&nbsp;defaultValue)</PRE>
<DL>
<DD>Returns a boolean value local property. Local properties are stored in the
 file defined in <tt>JIVE_CONFIG_FILENAME</tt> that exists in the <tt>home</tt>
 directory. Properties are always specified as "foo.bar.prop", which would map to
 the following entry in the XML file:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>

 If the specified property can't be found, the <tt>defaultValue</tt> will be returned.
 If the property is found, it will be parsed using <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html#valueOf(java.lang.String)" title="class or interface in java.lang"><CODE>Boolean.valueOf(String)</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to return.<DD><CODE>defaultValue</CODE> - value returned if the property could not be loaded or was not
      a number.
<DT><B>Returns:</B><DD>the property value specified by name or <tt>defaultValue</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="setXMLProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
setXMLProperty</H3>
<PRE>
public static void <B>setXMLProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                                  <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value)</PRE>
<DL>
<DD>Sets a local property. If the property doesn't already exists, a new
 one will be created. Local properties are stored in the file defined in
 <tt>JIVE_CONFIG_FILENAME</tt> that exists in the <tt>home</tt> directory.
 Properties are always specified as "foo.bar.prop", which would map to
 the following entry in the XML file:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property being set.<DD><CODE>value</CODE> - the value of the property being set.</DL>
</DD>
</DL>
<HR>

<A NAME="setXMLProperties(java.util.Map)"><!-- --></A><H3>
setXMLProperties</H3>
<PRE>
public static void <B>setXMLProperties</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&gt;&nbsp;propertyMap)</PRE>
<DL>
<DD>Sets multiple local properties at once. If a property doesn't already exists, a new
 one will be created. Local properties are stored in the file defined in
 <tt>JIVE_CONFIG_FILENAME</tt> that exists in the <tt>home</tt> directory.
 Properties are always specified as "foo.bar.prop", which would map to
 the following entry in the XML file:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>propertyMap</CODE> - a map of properties, keyed on property name.</DL>
</DD>
</DL>
<HR>

<A NAME="getXMLProperties(java.lang.String)"><!-- --></A><H3>
getXMLProperties</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>getXMLProperties</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;parent)</PRE>
<DL>
<DD>Return all immediate children property values of a parent local property as a list of strings,
 or an empty list if there are no children. For example, given
 the properties <tt>X.Y.A</tt>, <tt>X.Y.B</tt>, <tt>X.Y.C</tt> and <tt>X.Y.C.D</tt>, then
 the immediate child properties of <tt>X.Y</tt> are <tt>A</tt>, <tt>B</tt>, and
 <tt>C</tt> (the value of <tt>C.D</tt> would not be returned using this method).<p>

 Local properties are stored in the file defined in <tt>JIVE_CONFIG_FILENAME</tt> that exists
 in the <tt>home</tt> directory. Properties are always specified as "foo.bar.prop",
 which would map to the following entry in the XML file:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the name of the parent property to return the children for.
<DT><B>Returns:</B><DD>all child property values for the given parent.</DL>
</DD>
</DL>
<HR>

<A NAME="deleteXMLProperty(java.lang.String)"><!-- --></A><H3>
deleteXMLProperty</H3>
<PRE>
public static void <B>deleteXMLProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Deletes a locale property. If the property doesn't exist, the method
 does nothing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to delete.</DL>
</DD>
</DL>
<HR>

<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Returns a Jive property.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to return.
<DT><B>Returns:</B><DD>the property value specified by name.</DL>
</DD>