← Back to branch summary

~testplan-team/testplan/source-collection

« back to all changes in this revision

Viewing changes to commons-httpclient-3.1/docs/apidocs/org/apache/commons/httpclient/util/ExceptionUtil.html

  • Committer: edA-qa mort-ora-y
  • Date: 2009-01-28 15:36:51 UTC
  • Revision ID: eda-qa@disemia.com-20090128153651-u4uzd035zyjea16j
adding httpclient

Show diffs side-by-side

added added

removed removed

Lines of Context:
commons-httpclient-3.1/docs/apidocs/org/apache/commons/httpclient/util/ExceptionUtil.html
 
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.5.0_11) on Sat Aug 18 11:01:02 CEST 2007 -->
 
6
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 
7
<TITLE>
 
8
ExceptionUtil (HttpClient 3.1 API)
 
9
</TITLE>
 
10
 
 
11
<META NAME="keywords" CONTENT="org.apache.commons.httpclient.util.ExceptionUtil class">
 
12
 
 
13
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
14
 
 
15
<SCRIPT type="text/javascript">
 
16
function windowTitle()
 
17
{
 
18
    parent.document.title="ExceptionUtil (HttpClient 3.1 API)";
 
19
}
 
20
</SCRIPT>
 
21
<NOSCRIPT>
 
22
</NOSCRIPT>
 
23
 
 
24
</HEAD>
 
25
 
 
26
<BODY BGCOLOR="white" onload="windowTitle();">
 
27
 
 
28
 
 
29
<!-- ========= START OF TOP NAVBAR ======= -->
 
30
<A NAME="navbar_top"><!-- --></A>
 
31
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 
32
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 
33
<TR>
 
34
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
35
<A NAME="navbar_top_firstrow"><!-- --></A>
 
36
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 
37
  <TR ALIGN="center" VALIGN="top">
 
38
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
39
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
40
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ExceptionUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
42
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
46
  </TR>
 
47
</TABLE>
 
48
</TD>
 
49
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
50
</EM>
 
51
</TD>
 
52
</TR>
 
53
 
 
54
<TR>
 
55
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
56
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/EncodingUtil.html" title="class in org.apache.commons.httpclient.util"><B>PREV CLASS</B></A>&nbsp;
 
57
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/HttpURLConnection.html" title="class in org.apache.commons.httpclient.util"><B>NEXT CLASS</B></A></FONT></TD>
 
58
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
59
  <A HREF="../../../../../index.html?org/apache/commons/httpclient/util/ExceptionUtil.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 
60
&nbsp;<A HREF="ExceptionUtil.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
61
&nbsp;<SCRIPT type="text/javascript">
 
62
  <!--
 
63
  if(window==top) {
 
64
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
65
  }
 
66
  //-->
 
67
</SCRIPT>
 
68
<NOSCRIPT>
 
69
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 
70
</NOSCRIPT>
 
71
 
 
72
 
 
73
</FONT></TD>
 
74
</TR>
 
75
<TR>
 
76
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
77
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
78
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
79
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
80
</TR>
 
81
</TABLE>
 
82
<A NAME="skip-navbar_top"></A>
 
83
<!-- ========= END OF TOP NAVBAR ========= -->
 
84
 
 
85
<HR>
 
86
<!-- ======== START OF CLASS DATA ======== -->
 
87
<H2>
 
88
<FONT SIZE="-1">
 
89
org.apache.commons.httpclient.util</FONT>
 
90
<BR>
 
91
Class ExceptionUtil</H2>
 
92
<PRE>
 
93
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
 
94
  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.httpclient.util.ExceptionUtil</B>
 
95
</PRE>
 
96
<HR>
 
97
<DL>
 
98
<DT><PRE>public class <B>ExceptionUtil</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
 
99
</PRE>
 
100
 
 
101
<P>
 
102
The home for utility methods that handle various exception-related tasks.
 
103
<P>
 
104
 
 
105
<P>
 
106
<DL>
 
107
<DT><B>Since:</B></DT>
 
108
  <DD>3.0</DD>
 
109
<DT><B>Author:</B></DT>
 
110
  <DD><a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>, <a href="mailto:laura@lwerner.org">Laura Werner</a></DD>
 
111
</DL>
 
112
<HR>
 
113
 
 
114
<P>
 
115
 
 
116
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
117
 
 
118
<A NAME="constructor_summary"><!-- --></A>
 
119
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
120
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
121
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 
122
<B>Constructor Summary</B></FONT></TH>
 
123
</TR>
 
124
<TR BGCOLOR="white" CLASS="TableRowColor">
 
125
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/ExceptionUtil.html#ExceptionUtil()">ExceptionUtil</A></B>()</CODE>
 
126
 
 
127
<BR>
 
128
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
129
</TR>
 
130
</TABLE>
 
131
&nbsp;
 
132
<!-- ========== METHOD SUMMARY =========== -->
 
133
 
 
134
<A NAME="method_summary"><!-- --></A>
 
135
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
136
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
137
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 
138
<B>Method Summary</B></FONT></TH>
 
139
</TR>
 
140
<TR BGCOLOR="white" CLASS="TableRowColor">
 
141
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
142
<CODE>static&nbsp;void</CODE></FONT></TD>
 
143
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/ExceptionUtil.html#initCause(java.lang.Throwable, java.lang.Throwable)">initCause</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A>&nbsp;throwable,
 
144
          <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A>&nbsp;cause)</CODE>
 
145
 
 
146
<BR>
 
147
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If we're running on JDK 1.4 or later, initialize the cause for the given throwable.</TD>
 
148
</TR>
 
149
<TR BGCOLOR="white" CLASS="TableRowColor">
 
150
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
151
<CODE>static&nbsp;boolean</CODE></FONT></TD>
 
152
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/ExceptionUtil.html#isSocketTimeoutException(java.io.InterruptedIOException)">isSocketTimeoutException</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InterruptedIOException.html" title="class or interface in java.io">InterruptedIOException</A>&nbsp;e)</CODE>
 
153
 
 
154
<BR>
 
155
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If SocketTimeoutExceptionClass is defined, returns <tt>true</tt> only if the 
 
156
 exception is an instance of SocketTimeoutExceptionClass.</TD>
 
157
</TR>
 
158
</TABLE>
 
159
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
160
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
161
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
162
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
 
163
</TR>
 
164
<TR BGCOLOR="white" CLASS="TableRowColor">
 
165
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/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.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
 
166
</TR>
 
167
</TABLE>
 
168
&nbsp;
 
169
<P>
 
170
 
 
171
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
172
 
 
173
<A NAME="constructor_detail"><!-- --></A>
 
174
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
175
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
176
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 
177
<B>Constructor Detail</B></FONT></TH>
 
178
</TR>
 
179
</TABLE>
 
180
 
 
181
<A NAME="ExceptionUtil()"><!-- --></A><H3>
 
182
ExceptionUtil</H3>
 
183
<PRE>
 
184
public <B>ExceptionUtil</B>()</PRE>
 
185
<DL>
 
186
</DL>
 
187
 
 
188
<!-- ============ METHOD DETAIL ========== -->
 
189
 
 
190
<A NAME="method_detail"><!-- --></A>
 
191
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
192
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
193
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 
194
<B>Method Detail</B></FONT></TH>
 
195
</TR>
 
196
</TABLE>
 
197
 
 
198
<A NAME="initCause(java.lang.Throwable, java.lang.Throwable)"><!-- --></A><H3>
 
199
initCause</H3>
 
200
<PRE>
 
201
public static void <B>initCause</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A>&nbsp;throwable,
 
202
                             <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A>&nbsp;cause)</PRE>
 
203
<DL>
 
204
<DD>If we're running on JDK 1.4 or later, initialize the cause for the given throwable.
 
205
<P>
 
206
<DD><DL>
 
207
<DT><B>Parameters:</B><DD><CODE>throwable</CODE> - The throwable.<DD><CODE>cause</CODE> - The cause of the throwable.</DL>
 
208
</DD>
 
209
</DL>
 
210
<HR>
 
211
 
 
212
<A NAME="isSocketTimeoutException(java.io.InterruptedIOException)"><!-- --></A><H3>
 
213
isSocketTimeoutException</H3>
 
214
<PRE>
 
215
public static boolean <B>isSocketTimeoutException</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InterruptedIOException.html" title="class or interface in java.io">InterruptedIOException</A>&nbsp;e)</PRE>
 
216
<DL>
 
217
<DD>If SocketTimeoutExceptionClass is defined, returns <tt>true</tt> only if the 
 
218
 exception is an instance of SocketTimeoutExceptionClass. If 
 
219
 SocketTimeoutExceptionClass is undefined, always returns <tt>true</tt>.
 
220
<P>
 
221
<DD><DL>
 
222
<DT><B>Parameters:</B><DD><CODE>e</CODE> - an instance of InterruptedIOException class.
 
223
<DT><B>Returns:</B><DD><tt>true</tt> if the exception signals socket timeout, <tt>false</tt>
 
224
  otherwise.</DL>
 
225
</DD>
 
226
</DL>
 
227
<!-- ========= END OF CLASS DATA ========= -->
 
228
<HR>
 
229
 
 
230
 
 
231
<!-- ======= START OF BOTTOM NAVBAR ====== -->
 
232
<A NAME="navbar_bottom"><!-- --></A>
 
233
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 
234
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 
235
<TR>
 
236
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
237
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
238
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 
239
  <TR ALIGN="center" VALIGN="top">
 
240
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
241
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
242
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
243
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ExceptionUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
244
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
245
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
246
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
247
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
248
  </TR>
 
249
</TABLE>
 
250
</TD>
 
251
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
252
</EM>
 
253
</TD>
 
254
</TR>
 
255
 
 
256
<TR>
 
257
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
258
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/EncodingUtil.html" title="class in org.apache.commons.httpclient.util"><B>PREV CLASS</B></A>&nbsp;
 
259
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/HttpURLConnection.html" title="class in org.apache.commons.httpclient.util"><B>NEXT CLASS</B></A></FONT></TD>
 
260
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
261
  <A HREF="../../../../../index.html?org/apache/commons/httpclient/util/ExceptionUtil.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 
262
&nbsp;<A HREF="ExceptionUtil.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
263
&nbsp;<SCRIPT type="text/javascript">
 
264
  <!--
 
265
  if(window==top) {
 
266
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
267
  }
 
268
  //-->
 
269
</SCRIPT>
 
270
<NOSCRIPT>
 
271
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 
272
</NOSCRIPT>
 
273
 
 
274
 
 
275
</FONT></TD>
 
276
</TR>
 
277
<TR>
 
278
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
279
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
280
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
281
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
282
</TR>
 
283
</TABLE>
 
284
<A NAME="skip-navbar_bottom"></A>
 
285
<!-- ======== END OF BOTTOM NAVBAR ======= -->
 
286
 
 
287
<HR>
 
288
Copyright &copy; 2001-2007 Apache Software Foundation. All Rights Reserved.
 
289
</BODY>
 
290
</HTML>