configparams.html

jxta的api库

<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="modCount"><!-- --></A><H3>
modCount</H3>
<PRE>
protected transient volatile int <B>modCount</B></PRE>
<DL>
<DD>Counts the changes made to this object. The API increments it everytime
 some change is not proven to be idempotent. We rely on implementations to
 increment modCount everytime something is changed without going through
 the API.
<P>
<DL>
</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="ConfigParams()"><!-- --></A><H3>
ConfigParams</H3>
<PRE>
public <B>ConfigParams</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="getModCount()"><!-- --></A><H3>
getModCount</H3>
<PRE>
public int <B>getModCount</B>()</PRE>
<DL>
<DD>Returns the number of times this object has been modified since
 it was created.
 This permits the detection of local changes that require refreshing some
 other data.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>int the current modification count.</DL>
</DD>
</DL>
<HR>

<A NAME="incModCount()"><!-- --></A><H3>
incModCount</H3>
<PRE>
protected int <B>incModCount</B>()</PRE>
<DL>
<DD>Increases the modification count of the
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAdvertisementType()"><!-- --></A><H3>
getAdvertisementType</H3>
<PRE>
public static java.lang.String <B>getAdvertisementType</B>()</PRE>
<DL>
<DD>{@inheritDoc}
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getBaseAdvType()"><!-- --></A><H3>
getBaseAdvType</H3>
<PRE>
public final java.lang.String <B>getBaseAdvType</B>()</PRE>
<DL>
<DD>Returns the base type of this advertisement hierarchy. Typically, only
  the most basic advertisement of a type will implement this method and
  declare it as <code>final</code>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/jxta/document/ExtendableAdvertisement.html#getBaseAdvType()">getBaseAdvType</A></CODE> in class <CODE><A HREF="../../../net/jxta/document/ExtendableAdvertisement.html" title="class in net.jxta.document">ExtendableAdvertisement</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>String the base type of advertisements in this hierarchy.</DL>
</DD>
</DL>
<HR>

<A NAME="putServiceParam(net.jxta.id.ID, net.jxta.document.Element)"><!-- --></A><H3>
putServiceParam</H3>
<PRE>
public void <B>putServiceParam</B>(<A HREF="../../../net/jxta/id/ID.html" title="class in net.jxta.id">ID</A>&nbsp;key,
                            <A HREF="../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;param)</PRE>
<DL>
<DD>Puts a service parameter in the service parameters table
 under the given key. The key is of a subclass of ID; usually a
 ModuleClassID. This method makes a deep copy of the given element
 into an independent document.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The key.<DD><CODE>param</CODE> - The parameter, as an element. What is stored is a copy as
 a standalone StructuredDocument which type is the element's name.</DL>
</DD>
</DL>
<HR>

<A NAME="getServiceParam(net.jxta.id.ID)"><!-- --></A><H3>
getServiceParam</H3>
<PRE>
public <A HREF="../../../net/jxta/document/StructuredDocument.html" title="interface in net.jxta.document">StructuredDocument</A> <B>getServiceParam</B>(<A HREF="../../../net/jxta/id/ID.html" title="class in net.jxta.id">ID</A>&nbsp;key)</PRE>
<DL>
<DD>Returns the parameter element that matches the given key from the
 service parameters table. The key is of a subclass of ID; usually a
 ModuleClassID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The key.
<DT><B>Returns:</B><DD>StructuredDocument The matching parameter document or null if
 none matched.</DL>
</DD>
</DL>
<HR>

<A NAME="removeServiceParam(net.jxta.id.ID)"><!-- --></A><H3>
removeServiceParam</H3>
<PRE>
public <A HREF="../../../net/jxta/document/StructuredDocument.html" title="interface in net.jxta.document">StructuredDocument</A> <B>removeServiceParam</B>(<A HREF="../../../net/jxta/id/ID.html" title="class in net.jxta.id">ID</A>&nbsp;key)</PRE>
<DL>
<DD>Removes and returns the parameter element that matches the given key
 from the service parameters table. The key is of a subclass of ID;
 usually a ModuleClassID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The key.
<DT><B>Returns:</B><DD>Element the removed parameter element or null if not found.
 This is actually a StructureDocument of type "Param".</DL>
</DD>
</DL>
<HR>

<A NAME="getServiceParamsEntrySet()"><!-- --></A><H3>
getServiceParamsEntrySet</H3>
<PRE>
public java.util.Set <B>getServiceParamsEntrySet</B>()</PRE>
<DL>
<DD>Returns the set of params held by this object. The parameters are not
  copied and any changes to the Set are reflected in this object's version.
  incModCount should be called as appropriate.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="handleElement(net.jxta.document.Element)"><!-- --></A><H3>
handleElement</H3>
<PRE>
protected boolean <B>handleElement</B>(<A HREF="../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;raw)</PRE>
<DL>
<DD>Process an individual element from the document during parse. Normally,
  implementations will allow the base advertisments a chance to handle the
  element before attempting ot handle the element themselves. ie.

  <p/><pre><code>
  protected boolean handleElement( Element elem ) {

      if ( super.handleElement() ) {
           // it's been handled.
           return true;
           }

      <i>... handle elements here ...</i>

      // we don't know how to handle the element
      return false;
      }
  </code></pre>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../net/jxta/document/ExtendableAdvertisement.html#handleElement(net.jxta.document.Element)">handleElement</A></CODE> in class <CODE><A HREF="../../../net/jxta/document/ExtendableAdvertisement.html" title="class in net.jxta.document">ExtendableAdvertisement</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>raw</CODE> - the element to be processed.
<DT><B>Returns:</B><DD>true if the element was recognized, otherwise false.</DL>
</DD>
</DL>
<HR>

<A NAME="addDocumentElements(net.jxta.document.StructuredDocument)"><!-- --></A><H3>
addDocumentElements</H3>
<PRE>
public boolean <B>addDocumentElements</B>(<A HREF="../../../net/jxta/document/StructuredDocument.html" title="interface in net.jxta.document">StructuredDocument</A>&nbsp;adv)</PRE>
<DL>
<DD>Return the advertisement as a document.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if elements were added otherwise false</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>&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="class-use/ConfigParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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>
JXTA J2SE</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../net/jxta/protocol/BuildTag.html" title="class in net.jxta.protocol"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../net/jxta/protocol/DiscoveryQueryMsg.html" title="class in net.jxta.protocol"><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>  &nbsp;
&nbsp;<A HREF="ConfigParams.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;<A HREF="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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>

</BODY>
</HTML>