source: branches/objectmq_old/lib/rabbitmq-java-client-javadoc-3.0.1/com/rabbitmq/client/Address.html

Last change on this file was 9, checked in by stoda, 12 years ago

First commit
File size: 14.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_18) on Tue Dec 11 11:47:09 GMT 2012 -->
6<TITLE>
7Address
8</TITLE>
9
10<META NAME="date" CONTENT="2012-12-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="Address";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47  </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51</EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57&nbsp;PREV CLASS&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/AlreadyClosedException.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60  <A HREF="../../../index.html?com/rabbitmq/client/Address.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="Address.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<SCRIPT type="text/javascript">
63  <!--
64  if(window==top) {
65    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
66  }
67  //-->
68</SCRIPT>
69<NOSCRIPT>
70  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90com.rabbitmq.client</FONT>
91<BR>
92Class Address</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.Address</B>
96</PRE>
97<HR>
98<DL>
99<DT><PRE>public class <B>Address</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103A representation of network addresses, i.e. host/port pairs,
104 with some utility functions for parsing address strings.
105<P>
106
107<P>
108<HR>
109
110<P>
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
118<B>Constructor Summary</B></FONT></TH>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#Address(java.lang.String)">Address</A></B>(java.lang.String&nbsp;host)</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an address from a host.</TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#Address(java.lang.String, int)">Address</A></B>(java.lang.String&nbsp;host,
128        int&nbsp;port)</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an address from a host name and port number.</TD>
132</TR>
133</TABLE>
134&nbsp;
135<!-- ========== METHOD SUMMARY =========== -->
136
137<A NAME="method_summary"><!-- --></A>
138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
141<B>Method Summary</B></FONT></TH>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;boolean</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#getHost()">getHost</A></B>()</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the host name</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;int</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#getPort()">getPort</A></B>()</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the port number</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;int</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#hashCode()">hashCode</A></B>()</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>static&nbsp;<A HREF="../../../com/rabbitmq/client/Address.html" title="class in com.rabbitmq.client">Address</A></CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#parseAddress(java.lang.String)">parseAddress</A></B>(java.lang.String&nbsp;addressString)</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Factory method: takes a formatted addressString string as construction parameter</TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>static&nbsp;<A HREF="../../../com/rabbitmq/client/Address.html" title="class in com.rabbitmq.client">Address</A>[]</CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#parseAddresses(java.lang.String)">parseAddresses</A></B>(java.lang.String&nbsp;addresses)</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Array-based factory method: takes an array of formatted address strings as construction parameter</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
194<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Address.html#toString()">toString</A></B>()</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
198</TR>
199</TABLE>
200&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
201<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
203<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
207</TR>
208</TABLE>
209&nbsp;
210<P>
211
212<!-- ========= CONSTRUCTOR DETAIL ======== -->
213
214<A NAME="constructor_detail"><!-- --></A>
215<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
217<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
218<B>Constructor Detail</B></FONT></TH>
219</TR>
220</TABLE>
221
222<A NAME="Address(java.lang.String, int)"><!-- --></A><H3>
223Address</H3>
224<PRE>
225public <B>Address</B>(java.lang.String&nbsp;host,
226               int&nbsp;port)</PRE>
227<DL>
228<DD>Construct an address from a host name and port number.
229<P>
230<DL>
231<DT><B>Parameters:</B><DD><CODE>host</CODE> - the host name<DD><CODE>port</CODE> - the port number</DL>
232</DL>
233<HR>
234
235<A NAME="Address(java.lang.String)"><!-- --></A><H3>
236Address</H3>
237<PRE>
238public <B>Address</B>(java.lang.String&nbsp;host)</PRE>
239<DL>
240<DD>Construct an address from a host.
241<P>
242<DL>
243<DT><B>Parameters:</B><DD><CODE>host</CODE> - the host name</DL>
244</DL>
245
246<!-- ============ METHOD DETAIL ========== -->
247
248<A NAME="method_detail"><!-- --></A>
249<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
251<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
252<B>Method Detail</B></FONT></TH>
253</TR>
254</TABLE>
255
256<A NAME="getHost()"><!-- --></A><H3>
257getHost</H3>
258<PRE>
259public java.lang.String <B>getHost</B>()</PRE>
260<DL>
261<DD>Get the host name
262<P>
263<DD><DL>
264
265<DT><B>Returns:</B><DD>the host name</DL>
266</DD>
267</DL>
268<HR>
269
270<A NAME="getPort()"><!-- --></A><H3>
271getPort</H3>
272<PRE>
273public int <B>getPort</B>()</PRE>
274<DL>
275<DD>Get the port number
276<P>
277<DD><DL>
278
279<DT><B>Returns:</B><DD>the port number</DL>
280</DD>
281</DL>
282<HR>
283
284<A NAME="parseAddress(java.lang.String)"><!-- --></A><H3>
285parseAddress</H3>
286<PRE>
287public static <A HREF="../../../com/rabbitmq/client/Address.html" title="class in com.rabbitmq.client">Address</A> <B>parseAddress</B>(java.lang.String&nbsp;addressString)</PRE>
288<DL>
289<DD>Factory method: takes a formatted addressString string as construction parameter
290<P>
291<DD><DL>
292<DT><B>Parameters:</B><DD><CODE>addressString</CODE> - an addressString of the form "host[:port]".
293<DT><B>Returns:</B><DD>an <A HREF="../../../com/rabbitmq/client/Address.html" title="class in com.rabbitmq.client"><CODE>Address</CODE></A> from the given data</DL>
294</DD>
295</DL>
296<HR>
297
298<A NAME="parseAddresses(java.lang.String)"><!-- --></A><H3>
299parseAddresses</H3>
300<PRE>
301public static <A HREF="../../../com/rabbitmq/client/Address.html" title="class in com.rabbitmq.client">Address</A>[] <B>parseAddresses</B>(java.lang.String&nbsp;addresses)</PRE>
302<DL>
303<DD>Array-based factory method: takes an array of formatted address strings as construction parameter
304<P>
305<DD><DL>
306<DT><B>Parameters:</B><DD><CODE>addresses</CODE> - array of strings of form "host[:port],..."
307<DT><B>Returns:</B><DD>a list of <A HREF="../../../com/rabbitmq/client/Address.html" title="class in com.rabbitmq.client"><CODE>Address</CODE></A> values</DL>
308</DD>
309</DL>
310<HR>
311
312<A NAME="hashCode()"><!-- --></A><H3>
313hashCode</H3>
314<PRE>
315public int <B>hashCode</B>()</PRE>
316<DL>
317<DD><DL>
318<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
319</DD>
320<DD><DL>
321</DL>
322</DD>
323</DL>
324<HR>
325
326<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
327equals</H3>
328<PRE>
329public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>
330<DL>
331<DD><DL>
332<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
333</DD>
334<DD><DL>
335</DL>
336</DD>
337</DL>
338<HR>
339
340<A NAME="toString()"><!-- --></A><H3>
341toString</H3>
342<PRE>
343public java.lang.String <B>toString</B>()</PRE>
344<DL>
345<DD><DL>
346<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
347</DD>
348<DD><DL>
349</DL>
350</DD>
351</DL>
352<!-- ========= END OF CLASS DATA ========= -->
353<HR>
354
355
356<!-- ======= START OF BOTTOM NAVBAR ====== -->
357<A NAME="navbar_bottom"><!-- --></A>
358<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
359<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
360<TR>
361<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
362<A NAME="navbar_bottom_firstrow"><!-- --></A>
363<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
364  <TR ALIGN="center" VALIGN="top">
365  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
366  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
367  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
368  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
369  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
370  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
371  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
372  </TR>
373</TABLE>
374</TD>
375<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
376</EM>
377</TD>
378</TR>
379
380<TR>
381<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
382&nbsp;PREV CLASS&nbsp;
383&nbsp;<A HREF="../../../com/rabbitmq/client/AlreadyClosedException.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
384<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
385  <A HREF="../../../index.html?com/rabbitmq/client/Address.html" target="_top"><B>FRAMES</B></A>  &nbsp;
386&nbsp;<A HREF="Address.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
387&nbsp;<SCRIPT type="text/javascript">
388  <!--
389  if(window==top) {
390    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
391  }
392  //-->
393</SCRIPT>
394<NOSCRIPT>
395  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
396</NOSCRIPT>
397
398
399</FONT></TD>
400</TR>
401<TR>
402<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
403  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
404<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
405DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
406</TR>
407</TABLE>
408<A NAME="skip-navbar_bottom"></A>
409<!-- ======== END OF BOTTOM NAVBAR ======= -->
410
411<HR>
412
413</BODY>
414</HTML>
Note: See TracBrowser for help on using the repository browser.