jid.html

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

<TD><CODE><B><A HREF="../../../org/xmpp/packet/JID.html#readExternal(java.io.ObjectInput)">readExternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/ObjectInput.html" title="class or interface in java.io">ObjectInput</A>&nbsp;in)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/xmpp/packet/JID.html#resourceprep(java.lang.String)">resourceprep</A></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;resource)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/xmpp/packet/JID.html#toBareJID()">toBareJID</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the String representation of the bare JID, which is the JID with
 resource information removed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/xmpp/packet/JID.html#toString()">toString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a String representation of the JID.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/xmpp/packet/JID.html#unescapeNode(java.lang.String)">unescapeNode</A></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;node)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Un-escapes the node portion of a JID according to "JID Escaping" (JEP-0106).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/xmpp/packet/JID.html#writeExternal(java.io.ObjectOutput)">writeExternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/ObjectOutput.html" title="class or interface in java.io">ObjectOutput</A>&nbsp;out)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

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

<A NAME="JID()"><!-- --></A><H3>
JID</H3>
<PRE>
public <B>JID</B>()</PRE>
<DL>
<DD>Constructor added for Externalizable. Do not use this constructor.
<P>
</DL>
<HR>

<A NAME="JID(java.lang.String)"><!-- --></A><H3>
JID</H3>
<PRE>
public <B>JID</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;jid)</PRE>
<DL>
<DD>Constructs a JID from it's String representation.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - a valid JID.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the JID is not valid.</DL>
</DL>
<HR>

<A NAME="JID(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
JID</H3>
<PRE>
public <B>JID</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;node,
           <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;domain,
           <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;resource)</PRE>
<DL>
<DD>Constructs a JID given a node, domain, and resource.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node.<DD><CODE>domain</CODE> - the domain, which must not be <tt>null</tt>.<DD><CODE>resource</CODE> - the resource.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the JID is not valid.</DL>
</DL>
<HR>

<A NAME="JID(java.lang.String, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
JID</H3>
<PRE>
public <B>JID</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;node,
           <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;domain,
           <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;resource,
           boolean&nbsp;skipStringprep)</PRE>
<DL>
<DD>Constructs a JID given a node, domain, and resource being able to specify if stringprep
 should be applied or not.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node.<DD><CODE>domain</CODE> - the domain, which must not be <tt>null</tt>.<DD><CODE>resource</CODE> - the resource.<DD><CODE>skipStringprep</CODE> - true if stringprep should not be applied.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the JID is not valid.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<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="escapeNode(java.lang.String)"><!-- --></A><H3>
escapeNode</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>escapeNode</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;node)</PRE>
<DL>
<DD>Escapes the node portion of a JID according to "JID Escaping" (JEP-0106).
 Escaping replaces characters prohibited by node-prep with escape sequences,
 as follows:<p>

 <table border="1">
 <tr><td><b>Unescaped Character</b></td><td><b>Encoded Sequence</b></td></tr>
 <tr><td>&lt;space&gt;</td><td>\20</td></tr>
 <tr><td>"</td><td>\22</td></tr>
 <tr><td>&</td><td>\26</td></tr>
 <tr><td>'</td><td>\27</td></tr>
 <tr><td>/</td><td>\2f</td></tr>
 <tr><td>:</td><td>\3a</td></tr>
 <tr><td>&lt;</td><td>\3c</td></tr>
 <tr><td>&gt;</td><td>\3e</td></tr>
 <tr><td>@</td><td>\40</td></tr>
 <tr><td>\</td><td>\5c</td></tr>
 </table><p>

 This process is useful when the node comes from an external source that doesn't
 conform to nodeprep. For example, a username in LDAP may be "Joe Smith". Because
 the &lt;space&gt; character isn't a valid part of a node, the username should
 be escaped to "Joe\20Smith" before being made into a JID (e.g. "joe\[e-mail]"
 after case-folding, etc. has been applied).<p>

 All node escaping and un-escaping must be performed manually at the appropriate
 time; the JID class will not escape or un-escape automatically.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node.
<DT><B>Returns:</B><DD>the escaped version of the node.</DL>
</DD>
</DL>
<HR>

<A NAME="unescapeNode(java.lang.String)"><!-- --></A><H3>
unescapeNode</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>unescapeNode</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;node)</PRE>
<DL>
<DD>Un-escapes the node portion of a JID according to "JID Escaping" (JEP-0106).<p>
 Escaping replaces characters prohibited by node-prep with escape sequences,
 as follows:<p>

 <table border="1">
 <tr><td><b>Unescaped Character</b></td><td><b>Encoded Sequence</b></td></tr>
 <tr><td>&lt;space&gt;</td><td>\20</td></tr>
 <tr><td>"</td><td>\22</td></tr>
 <tr><td>&</td><td>\26</td></tr>
 <tr><td>'</td><td>\27</td></tr>
 <tr><td>/</td><td>\2f</td></tr>
 <tr><td>:</td><td>\3a</td></tr>
 <tr><td>&lt;</td><td>\3c</td></tr>
 <tr><td>&gt;</td><td>\3e</td></tr>
 <tr><td>@</td><td>\40</td></tr>
 <tr><td>\</td><td>\5c</td></tr>
 </table><p>

 This process is useful when the node comes from an external source that doesn't
 conform to nodeprep. For example, a username in LDAP may be "Joe Smith". Because
 the &lt;space&gt; character isn't a valid part of a node, the username should
 be escaped to "Joe\20Smith" before being made into a JID (e.g. "joe\[e-mail]"
 after case-folding, etc. has been applied).<p>

 All node escaping and un-escaping must be performed manually at the appropriate
 time; the JID class will not escape or un-escape automatically.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the escaped version of the node.
<DT><B>Returns:</B><DD>the un-escaped version of the node.</DL>
</DD>
</DL>
<HR>

<A NAME="resourceprep(java.lang.String)"><!-- --></A><H3>
resourceprep</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>resourceprep</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;resource)
                           throws org.jivesoftware.stringprep.StringprepException</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>org.jivesoftware.stringprep.StringprepException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getNode()"><!-- --></A><H3>
getNode</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>getNode</B>()</PRE>
<DL>
<DD>Returns the node, or <tt>null</tt> if this JID does not contain node information.
<P>
<DD><DL>