message.html

jxta的api库

  <p/>The iterator returned is not synchronized with the message and will
  throw <CODE>ConcurrentModificationException</CODE> if the
  message is modified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the elements to match against
<DT><B>Returns:</B><DD>iterator of the elements matching the specified name, if any.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageElementsOfNamespace(java.lang.String)"><!-- --></A><H3>
getMessageElementsOfNamespace</H3>
<PRE>
public <A HREF="../../../net/jxta/endpoint/Message.ElementIterator.html" title="class in net.jxta.endpoint">Message.ElementIterator</A> <B>getMessageElementsOfNamespace</B>(java.lang.String&nbsp;namespace)</PRE>
<DL>
<DD>Returns an list iterator  of all of the elements contained in this message
  which match the specified namespace.

  <p/>The iterator returned is not synchronized with the message and will
  throw <CODE>ConcurrentModificationException</CODE> if the
  message is modified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>namespace</CODE> - contains the namespace which must be matched in the
  elements returned. You can specify null as a shorthand for the default
  namespace.
<DT><B>Returns:</B><DD>Enumeration of Elements.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageElements(java.lang.String, java.lang.String)"><!-- --></A><H3>
getMessageElements</H3>
<PRE>
public <A HREF="../../../net/jxta/endpoint/Message.ElementIterator.html" title="class in net.jxta.endpoint">Message.ElementIterator</A> <B>getMessageElements</B>(java.lang.String&nbsp;namespace,
                                                  java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Returns a list iterator  of all of the elements contained in the
  specified namespace who's name matches the specified name.

  <p/>The iterator returned is not synchronized with the message and will
  throw <CODE>ConcurrentModificationException</CODE> if the
  message is modified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>namespace</CODE> - contains the namespace which must be matched in the
  elements returned. You can specify null as a shorthand for the default
  namespace.<DD><CODE>name</CODE> - contains the name of the elements to get
<DT><B>Returns:</B><DD>Enumeration of Elements.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageElements(net.jxta.document.MimeMediaType)"><!-- --></A><H3>
getMessageElements</H3>
<PRE>
public <A HREF="../../../net/jxta/endpoint/Message.ElementIterator.html" title="class in net.jxta.endpoint">Message.ElementIterator</A> <B>getMessageElements</B>(<A HREF="../../../net/jxta/document/MimeMediaType.html" title="class in net.jxta.document">MimeMediaType</A>&nbsp;type)</PRE>
<DL>
<DD>Returns a list iterator of all of the elements contained in this message
  whose mime-type matchs the given in the order they were added. Elements
  from all namespaces are returned.

  <p/>The iterator returned is not synchronized with the message and will
  throw <CODE>ConcurrentModificationException</CODE> if the
  message is modified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - contains the type of the elements to get
<DT><B>Returns:</B><DD>Enumeration of Elements.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageElements(java.lang.String, net.jxta.document.MimeMediaType)"><!-- --></A><H3>
getMessageElements</H3>
<PRE>
public <A HREF="../../../net/jxta/endpoint/Message.ElementIterator.html" title="class in net.jxta.endpoint">Message.ElementIterator</A> <B>getMessageElements</B>(java.lang.String&nbsp;namespace,
                                                  <A HREF="../../../net/jxta/document/MimeMediaType.html" title="class in net.jxta.document">MimeMediaType</A>&nbsp;type)</PRE>
<DL>
<DD>Returns a list iterator of all of the elements contained in this message
  whose type matches the given in the order they were added.

  <p/>The iterator returned is not synchronized with the message and will
  throw <CODE>ConcurrentModificationException</CODE> if the
  message is modified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>namespace</CODE> - contains the namespace which must be matched in the
  elements returned. You can specify null as a shorthand for the default
  namespace.<DD><CODE>type</CODE> - contains the type of the elements to get
<DT><B>Returns:</B><DD>Enumeration of Elements.</DL>
</DD>
</DL>
<HR>

<A NAME="removeMessageElement(net.jxta.endpoint.MessageElement)"><!-- --></A><H3>
removeMessageElement</H3>
<PRE>
public boolean <B>removeMessageElement</B>(<A HREF="../../../net/jxta/endpoint/MessageElement.html" title="class in net.jxta.endpoint">MessageElement</A>&nbsp;remove)</PRE>
<DL>
<DD>Remove an the first occurance of the provided MessageElement from the
  message.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>remove</CODE> - the Element to remove from the message.
<DT><B>Returns:</B><DD>boolean returns true if the element was removed, otherwise false.</DL>
</DD>
</DL>
<HR>

<A NAME="removeMessageElement(java.lang.String, net.jxta.endpoint.MessageElement)"><!-- --></A><H3>
removeMessageElement</H3>
<PRE>
public boolean <B>removeMessageElement</B>(java.lang.String&nbsp;namespace,
                                    <A HREF="../../../net/jxta/endpoint/MessageElement.html" title="class in net.jxta.endpoint">MessageElement</A>&nbsp;remove)</PRE>
<DL>
<DD>Remove the first occurance of the provided MessageElement within the
  specified namespace from the message.  You can specify null as a
  shorthand for the default namespace.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>namespace</CODE> - the namespace from which the element is to be removed.<DD><CODE>remove</CODE> - the Element to remove from the message.
<DT><B>Returns:</B><DD>boolean returns true if the element was removed, otherwise false.</DL>
</DD>
</DL>
<HR>

<A NAME="clear()"><!-- --></A><H3>
clear</H3>
<PRE>
public void <B>clear</B>()</PRE>
<DL>
<DD>Removes all of the elements in all namespaces from the message. Also
  clears any properties set for this message.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getByteLength()"><!-- --></A><H3>
getByteLength</H3>
<PRE>
public long <B>getByteLength</B>()</PRE>
<DL>
<DD>Returns the aggregate size of all the memeber elements.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the sum of all element sizes in bytes.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageModCount()"><!-- --></A><H3>
getMessageModCount</H3>
<PRE>
public int <B>getMessageModCount</B>()</PRE>
<DL>
<DD>Returns the modification count of this message. This ever ascending
  number can be used to determine if the message has been modified by
  another thread or for use in caching of parts of the message structure.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the modification count of this message.</DL>
</DD>
</DL>
<HR>

<A NAME="incMessageModCount()"><!-- --></A><H3>
incMessageModCount</H3>
<PRE>
protected int <B>incMessageModCount</B>()</PRE>
<DL>
<DD>Returns the modification count of this message. This ever ascending
  number can be used to determine if the message has been modified by
  another thread or for use in caching of parts of the message structure.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the modification count of this message.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageModHistory()"><!-- --></A><H3>
getMessageModHistory</H3>
<PRE>
public java.lang.String <B>getMessageModHistory</B>()</PRE>
<DL>
<DD>Returns a string containing the modification history for this message
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a string containing the</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageNumber()"><!-- --></A><H3>
getMessageNumber</H3>
<PRE>
public int <B>getMessageNumber</B>()</PRE>
<DL>
<DD>Returns the message number of this message. Message Numbers are intended
  to assist with debugging and the management of message cloning.

  <p/>Each message is assigned a unique number upon creation. Message
  Numbers are monotonically increasing for each message created.

  <p/>Message Numbers are transient, ie. if the message object is
  serialized then the message number after deserialization will be
  probably be a different value. Message numbers should not be used to
  record permanent relationships between messages.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>int this message's message number.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageLineage()"><!-- --></A><H3>
getMessageLineage</H3>
<PRE>
public java.util.Iterator <B>getMessageLineage</B>()</PRE>
<DL>
<DD>Returns an iterator which describes the lineage of this message. Each
  entry is an <CODE>Integer</CODE> Message Number. The first entry is
  this message's number, following entries are the ancestors of this
  message.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an Iterator of <CODE>Integer</CODE>. Each entry is a
  message number.</DL>
</DD>
</DL>
<HR>

<A NAME="setMessageProperty(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
setMessageProperty</H3>
<PRE>
public java.lang.Object <B>setMessageProperty</B>(java.lang.Object&nbsp;key,
                                           java.lang.Object&nbsp;value)</PRE>
<DL>
<DD>Associate a transient property with this message. if there was a
  previous value for the key provided then it is returned. This feature is
  useful for managing the state of messages during processing and for
  caching.

  <p/>The setting of particular keys may be controlled by a Java Security
  Manager. Keys of type 'java.lang.Class' are checked against the caller of
  this method. Only callers which are instances of the key class may modify
  the property. This check is not possible through reflection. All other
  types of keys are unchecked.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the property key<DD><CODE>value</CODE> - the value for the property
<DT><B>Returns:</B><DD>previous value for the property or null if no previous</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageProperty(java.lang.Object)"><!-- --></A><H3>
getMessageProperty</H3>
<PRE>
public java.lang.Object <B>getMessageProperty</B>(java.lang.Object&nbsp;key)</PRE>
<DL>
<DD>Retrieves a transient property from the set for this message.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the property key.
<DT><B>Returns:</B><DD>value for the property or null if no property for this key.</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/Message.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/endpoint/InputStreamMessageElement.html" title="class in net.jxta.endpoint"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../net/jxta/endpoint/Message.element.html" title="class in net.jxta.endpoint"><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="Message.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="#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>