collectionnode.html

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

isChildNode</H3>
<PRE>
public boolean <B>isChildNode</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A>&nbsp;child)</PRE>
<DL>
<DD>Returns true if the specified node is a first-level children of this collection
 node.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#isChildNode(org.jivesoftware.openfire.pubsub.Node)">isChildNode</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>child</CODE> - the node to check if it is a direct child of this node.
<DT><B>Returns:</B><DD>true if the specified node is a first-level children of this collection
         node.</DL>
</DD>
</DL>
<HR>

<A NAME="isDescendantNode(org.jivesoftware.openfire.pubsub.Node)"><!-- --></A><H3>
isDescendantNode</H3>
<PRE>
public boolean <B>isDescendantNode</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A>&nbsp;child)</PRE>
<DL>
<DD>Returns true if the specified node is a direct child node of this collection node or
 a descendant of the children nodes.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#isDescendantNode(org.jivesoftware.openfire.pubsub.Node)">isDescendantNode</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>child</CODE> - the node to check if it is a descendant of this node.
<DT><B>Returns:</B><DD>true if the specified node is a direct child node of this collection node or
         a descendant of the children nodes.</DL>
</DD>
</DL>
<HR>

<A NAME="getNodes()"><!-- --></A><H3>
getNodes</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A>&gt; <B>getNodes</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#getNodes()">Node</A></CODE></B></DD>
<DD>Returns the list of nodes contained by this node. Only <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>CollectionNode</CODE></A> may
 contain other nodes.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#getNodes()">getNodes</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the list of nodes contained by this node.</DL>
</DD>
</DL>
<HR>

<A NAME="getAssociationPolicy()"><!-- --></A><H3>
getAssociationPolicy</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.LeafNodeAssociationPolicy.html" title="enum in org.jivesoftware.openfire.pubsub">CollectionNode.LeafNodeAssociationPolicy</A> <B>getAssociationPolicy</B>()</PRE>
<DL>
<DD>Returns the policy that defines who may associate leaf nodes with a collection.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the policy that defines who may associate leaf nodes with a collection.</DL>
</DD>
</DL>
<HR>

<A NAME="getAssociationTrusted()"><!-- --></A><H3>
getAssociationTrusted</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&gt; <B>getAssociationTrusted</B>()</PRE>
<DL>
<DD>Returns the users that are allowed to associate leaf nodes with this collection node.
 This collection is going to be used only when the associationPolicy is <tt>whitelist</tt>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the users that are allowed to associate leaf nodes with this collection node.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxLeafNodes()"><!-- --></A><H3>
getMaxLeafNodes</H3>
<PRE>
public int <B>getMaxLeafNodes</B>()</PRE>
<DL>
<DD>Returns the max number of leaf nodes that this collection node might have. A value of
 -1 means that there is no limit.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the max number of leaf nodes that this collection node might have.</DL>
</DD>
</DL>
<HR>

<A NAME="isAssociationAllowed(org.xmpp.packet.JID)"><!-- --></A><H3>
isAssociationAllowed</H3>
<PRE>
public boolean <B>isAssociationAllowed</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD>Returns true if the specified user is allowed to associate a leaf node with this
 node. The decision is taken based on the association policy that the node is
 using.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the user trying to associate a leaf node with this node.
<DT><B>Returns:</B><DD>true if the specified user is allowed to associate a leaf node with this
         node.</DL>
</DD>
</DL>
<HR>

<A NAME="isMaxLeafNodeReached()"><!-- --></A><H3>
isMaxLeafNodeReached</H3>
<PRE>
public boolean <B>isMaxLeafNodeReached</B>()</PRE>
<DL>
<DD>Returns true if the max number of leaf nodes associated with this node has
 reached to the maximum allowed.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the max number of leaf nodes associated with this node has
         reached to the maximum allowed.</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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.LeafNodeAssociationPolicy.html" title="enum in org.jivesoftware.openfire.pubsub"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/pubsub/CollectionNode.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="CollectionNode.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.jivesoftware.openfire.pubsub.Node">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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>