📄 sipaddress.html
字号:
<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="getDisplayName()"><!-- --></A><H3>
getDisplayName</H3>
<PRE>
public java.lang.String <B>getDisplayName</B>()</PRE>
<DL>
<DD>Returns the display name of SIP address.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>display name or null if not available or if the address is the special <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="setDisplayName(java.lang.String)"><!-- --></A><H3>
setDisplayName</H3>
<PRE>
public void <B>setDisplayName</B>(java.lang.String name)</PRE>
<DL>
<DD>Sets the display name. Empty string or null removes the display name.
<P>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if the display name is invalid or the address represents the immutable <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="getScheme()"><!-- --></A><H3>
getScheme</H3>
<PRE>
public java.lang.String <B>getScheme</B>()</PRE>
<DL>
<DD>Returns the scheme of SIP address.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the scheme of this SIP address e.g. <tt>sip</tt> or <tt>sips</tt> or null if the address is the special <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="setScheme(java.lang.String)"><!-- --></A><H3>
setScheme</H3>
<PRE>
public void <B>setScheme</B>(java.lang.String scheme)</PRE>
<DL>
<DD>Sets the scheme of SIP address. Valid scheme format is defined in RFC 3261 [1] p.224
<P>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>java.lang.NullPointerException</CODE> - if scheme is null<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the scheme is invalid or the address represents the immutable <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="getUser()"><!-- --></A><H3>
getUser</H3>
<PRE>
public java.lang.String <B>getUser</B>()</PRE>
<DL>
<DD>Returns the user part of SIP address. There is no separate method for getting the password field so that if the password field is present in the address then <tt>getUser</tt> returns the value of <tt>'user:password'</tt> (instead of only <tt>'user'</tt>).
<P>
<DD><DL>
<DT><B>Returns:</B><DD>user part of SIP address. Returns <tt>null</tt> if the user part is missing or if the address is the special <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="setUser(java.lang.String)"><!-- --></A><H3>
setUser</H3>
<PRE>
public void <B>setUser</B>(java.lang.String user)</PRE>
<DL>
<DD>Sets the user part of SIP address. Empty string or null removes the user part.
<P>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if the user part is invalid or the address represents the immutable <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="getURI()"><!-- --></A><H3>
getURI</H3>
<PRE>
public java.lang.String <B>getURI</B>()</PRE>
<DL>
<DD>Returns the URI part of the address (without parameters). The URI part of the address is of the form <tt>scheme:user@host:port</tt>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the URI part of the address or <code>"*"</code> if the address is the special <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="setURI(java.lang.String)"><!-- --></A><H3>
setURI</H3>
<PRE>
public void <B>setURI</B>(java.lang.String URI)</PRE>
<DL>
<DD>Sets the URI part of the SIP address (without parameters). The URI part of the address is of the form <tt>scheme:user@host:port</tt>. If the parameter of the method contains URI parameters they don't overwrite existing URI parameters, they are simply ignored if present. Parameters can be manipulated by the <tt>get/set/removeParameter()</tt> calls.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>URI</CODE> - the URI part of the address to set<DT><B>Throws:</B><DD><CODE>java.lang.NullPointerException</CODE> - if URI is null<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the URI is <code>"*"</code> or invalid or the address represents the immutable <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="getHost()"><!-- --></A><H3>
getHost</H3>
<PRE>
public java.lang.String <B>getHost</B>()</PRE>
<DL>
<DD>Returns the host part of the SIP address.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>host part of this address or null if the address is the special <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="setHost(java.lang.String)"><!-- --></A><H3>
setHost</H3>
<PRE>
public void <B>setHost</B>(java.lang.String host)</PRE>
<DL>
<DD>Sets the host part of the SIP address.
<P>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>java.lang.NullPointerException</CODE> - if host is null<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the host is invalid or the address represents the immutable <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="getPort()"><!-- --></A><H3>
getPort</H3>
<PRE>
public int <B>getPort</B>()</PRE>
<DL>
<DD>Returns the port number of the SIP address. If port number is not set, return 5060 for <tt>sip:</tt> scheme and 5061 for <tt>sips:</tt> scheme. If the address is wildcard "*" return 0.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the port number or 0 if the address is the special <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="setPort(int)"><!-- --></A><H3>
setPort</H3>
<PRE>
public void <B>setPort</B>(int port)</PRE>
<DL>
<DD>Sets the port number of the SIP address. Valid range is 0-65535. After setting the port to 0 the port number is removed from the address URI, <tt>getPort</tt> returns the default 5060 value for <tt>sip:</tt> scheme and 5061 for <tt>sips:</tt> scheme.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>port</CODE> - port number. The valid range 0-65535, 0 means that port number is removed from the address URI<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if the port number is invalid or the address represents the immutable <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="getParameter(java.lang.String)"><!-- --></A><H3>
getParameter</H3>
<PRE>
public java.lang.String <B>getParameter</B>(java.lang.String name)</PRE>
<DL>
<DD>Returns the value associated with the named URI parameter.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the parameter<DT><B>Returns:</B><DD>the value of the named parameter, or empty string for parameters without value and null if the parameter is not defined or if the address is the special <code>"*"</code> value.<DT><B>Throws:</B><DD><CODE>java.lang.NullPointerException</CODE> - if name is null</DL>
</DD>
</DL>
<HR>
<A NAME="setParameter(java.lang.String, java.lang.String)"><!-- --></A><H3>
setParameter</H3>
<PRE>
public void <B>setParameter</B>(java.lang.String name, java.lang.String value)</PRE>
<DL>
<DD>Sets the named URI parameter to the specified value. If the value is null the parameter is interpreted as a parameter without value. Existing parameter will be overwritten, otherwise the parameter is added.
<P>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>java.lang.NullPointerException</CODE> - if name is null<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the parameter is invalid (RFC 3261, chapter 19.1.1 SIP and SIPS URI Components "URI parameters" p.149) or the address represents the immutable <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="removeParameter(java.lang.String)"><!-- --></A><H3>
removeParameter</H3>
<PRE>
public void <B>removeParameter</B>(java.lang.String name)</PRE>
<DL>
<DD>Removes the named URI parameter. The method returns without any action if the named parameter is not defined or if the address is the special <code>"*"</code> value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the parameter to remove<DT><B>Throws:</B><DD><CODE>java.lang.NullPointerException</CODE> - if name is null</DL>
</DD>
</DL>
<HR>
<A NAME="getParameterNames()"><!-- --></A><H3>
getParameterNames</H3>
<PRE>
public java.lang.String[] <B>getParameterNames</B>()</PRE>
<DL>
<DD>Returns a String array of all parameter names.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>String array of parameter names. Returns <tt>null</tt> if the address does not have any parameters or if the address is the special <code>"*"</code> value.</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Returns a fully qualified SIP address, with display name, URI and URI parameters. If display name is not specified only a SIP URI is returned. If the port is not explicitly set (to 5060 or other value) it will be omitted from the address URI in returned String.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a fully qualified SIP name address, SIP or SIPS URI or <code>"*"</code> if the address is the special <code>"*"</code> value.</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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../javax/microedition/sip/SipHeader.html" title="class in javax.microedition.sip"><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>
<A HREF="SipAddress.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A><!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size=-1>Copyright © 2003-2007 Nokia Corporation. All Rights Reserved.<br/> Java is a trademark of Sun Microsystems, Inc.
</BODY>
</HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -