elementutil.html

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

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getProperty(org.dom4j.Element, 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>(org.dom4j.Element&nbsp;element,
                                 <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 the value of the specified property. A <tt>null</tt> answer does not necessarily mean
 that the property does not exist.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to get.
<DT><B>Returns:</B><DD>the value of the specified property.</DL>
</DD>
</DL>
<HR>

<A NAME="includesProperty(org.dom4j.Element, java.lang.String)"><!-- --></A><H3>
includesProperty</H3>
<PRE>
public static boolean <B>includesProperty</B>(org.dom4j.Element&nbsp;element,
                                       <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 true if the specified property is included in the XML hierarchy. A property could
 have a value associated or not. If the property has an associated value then
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to find out.
<DT><B>Returns:</B><DD>true if the specified property is included in the XML hierarchy.</DL>
</DD>
</DL>
<HR>

<A NAME="getProperties(org.dom4j.Element, java.lang.String)"><!-- --></A><H3>
getProperties</H3>
<PRE>
public <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>getProperties</B>(org.dom4j.Element&nbsp;element,
                              <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>Return all values who's path matches the given property name as a String array,
 or an empty array if the if there are no children. You MAY NOT use the atttribute
 markup (using a ':' in the last element name) with this call.
 <p/>
 getProperties() allows you to retrieve several values with the same property name.
 For example, consider the XML file entry:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
         &lt;prop&gt;other value&lt;/prop&gt;
         &lt;prop&gt;last value&lt;/prop&gt;
     &lt;/bar&gt;
 &lt;/foo&gt;
 </pre>
 If you call getProperties("foo.bar.prop") will return a string array containing
 {"some value", "other value", "last value"}.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to retrieve
<DT><B>Returns:</B><DD>all child property values for the given node name.</DL>
</DD>
</DL>
<HR>

<A NAME="setProperties(org.dom4j.Element, java.lang.String, java.lang.String[])"><!-- --></A><H3>
setProperties</H3>
<PRE>
public static void <B>setProperties</B>(org.dom4j.Element&nbsp;element,
                                 <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;values)</PRE>
<DL>
<DD>Sets a property to an array of values.  You MAY NOT use the atttribute
 markup (using a ':' in the last element name) with this call. Multiple values matching the
 same property is mapped to an XML file as multiple elements containing each value.
 For example, using the name "foo.bar.prop", and the value string array containing
 {"some value", "other value", "last value"} would produce the following XML:
 <pre>
 &lt;foo&gt;
     &lt;bar&gt;
         &lt;prop&gt;some value&lt;/prop&gt;
         &lt;prop&gt;other value&lt;/prop&gt;
         &lt;prop&gt;last 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.<DD><CODE>values</CODE> - The array of values for the property (can be empty but not null)</DL>
</DD>
</DL>
<HR>

<A NAME="getChildrenProperties(org.dom4j.Element, java.lang.String)"><!-- --></A><H3>
getChildrenProperties</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>getChildrenProperties</B>(org.dom4j.Element&nbsp;element,
                                             <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 children property names of a parent property as a String array,
 or an empty array if the if there are no children. You MAY NOT use the atttribute
 markup (using a ':' in the last element name) with this call.
 For example, given the properties <tt>X.Y.A</tt>, <tt>X.Y.B</tt>, and <tt>X.Y.C</tt>, then
 the child properties of <tt>X.Y</tt> are <tt>A</tt>, <tt>B</tt>, and
 <tt>C</tt>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the name of the parent property.
<DT><B>Returns:</B><DD>all child property values for the given parent.</DL>
</DD>
</DL>
<HR>

<A NAME="getRecursiveChildrenProperties(org.dom4j.Element, java.lang.String)"><!-- --></A><H3>
getRecursiveChildrenProperties</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>getRecursiveChildrenProperties</B>(org.dom4j.Element&nbsp;element,
                                                      <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>Returns all recursive children of the given parent property or an empty string array
 if no children exist. The list of children is depth-first so the array is optimized
 for easy displaying.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent property.
<DT><B>Returns:</B><DD>all recursive children of the given property in depth-first order or an empty
         string array if no children exist.</DL>
</DD>
</DL>
<HR>

<A NAME="setProperty(org.dom4j.Element, java.lang.String, java.lang.String)"><!-- --></A><H3>
setProperty</H3>
<PRE>
public static void <B>setProperty</B>(org.dom4j.Element&nbsp;element,
                               <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 the value of the specified property. If the property doesn't
 currently exist, it will be automatically created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to set.<DD><CODE>value</CODE> - the new value for the property.</DL>
</DD>
</DL>
<HR>

<A NAME="deleteProperty(org.dom4j.Element, java.lang.String)"><!-- --></A><H3>
deleteProperty</H3>
<PRE>
public static void <B>deleteProperty</B>(org.dom4j.Element&nbsp;element,
                                  <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><p>Deletes the specified property.</p>
 <p>You MAY NOT use the atttribute
 markup (using a ':' in the last element name) with this call.
 deleteProperty() removes both the containing text, and the element itself along with
 any attributes associated with that element.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the property to delete.</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=2 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/jivesoftware/util/CookieUtils.html" title="class in org.jivesoftware.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/jivesoftware/util/EmailService.html" title="class in org.jivesoftware.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/jivesoftware/util/ElementUtil.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ElementUtil.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>