source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/io/retry/RetryPolicy.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project
  • Property svn:executable set to *
File size: 9.6 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_07) on Tue Sep 01 20:56:54 UTC 2009 -->
6<TITLE>
7RetryPolicy (Hadoop 0.20.1 API)
8</TITLE>
9
10<META NAME="date" CONTENT="2009-09-01">
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="RetryPolicy (Hadoop 0.20.1 API)";
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="class-use/RetryPolicy.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../org/apache/hadoop/io/retry/RetryPolicies.html" title="class in org.apache.hadoop.io.retry"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/hadoop/io/retry/RetryProxy.html" title="class in org.apache.hadoop.io.retry"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/hadoop/io/retry/RetryPolicy.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RetryPolicy.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.hadoop.io.retry</FONT>
92<BR>
93Interface RetryPolicy</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>RetryPolicy</B></DL>
97</PRE>
98
99<P>
100<p>
101 Specifies a policy for retrying method failures.
102 Implementations of this interface should be immutable.
103 </p>
104<P>
105
106<P>
107<HR>
108
109<P>
110
111<!-- ========== METHOD SUMMARY =========== -->
112
113<A NAME="method_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117<B>Method Summary</B></FONT></TH>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>&nbsp;boolean</CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/io/retry/RetryPolicy.html#shouldRetry(java.lang.Exception, int)">shouldRetry</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A>&nbsp;e,
123            int&nbsp;retries)</CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127 Determines whether the framework should retry a
128 method for the given exception, and the number
129 of retries that have been made for that operation
130 so far.</TD>
131</TR>
132</TABLE>
133&nbsp;
134<P>
135
136<!-- ============ METHOD DETAIL ========== -->
137
138<A NAME="method_detail"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
142<B>Method Detail</B></FONT></TH>
143</TR>
144</TABLE>
145
146<A NAME="shouldRetry(java.lang.Exception, int)"><!-- --></A><H3>
147shouldRetry</H3>
148<PRE>
149boolean <B>shouldRetry</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A>&nbsp;e,
150                    int&nbsp;retries)
151                    throws <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
152<DL>
153<DD><p>
154 Determines whether the framework should retry a
155 method for the given exception, and the number
156 of retries that have been made for that operation
157 so far.
158 </p>
159<P>
160<DD><DL>
161<DT><B>Parameters:</B><DD><CODE>e</CODE> - The exception that caused the method to fail.<DD><CODE>retries</CODE> - The number of times the method has been retried.
162<DT><B>Returns:</B><DD><code>true</code> if the method should be retried,
163   <code>false</code> if the method should not be retried
164   but shouldn't fail with an exception (only for void methods).
165<DT><B>Throws:</B>
166<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - The re-thrown exception <code>e</code> indicating
167   that the method failed and should not be retried further.</DL>
168</DD>
169</DL>
170<!-- ========= END OF CLASS DATA ========= -->
171<HR>
172
173
174<!-- ======= START OF BOTTOM NAVBAR ====== -->
175<A NAME="navbar_bottom"><!-- --></A>
176<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
177<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
178<TR>
179<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
180<A NAME="navbar_bottom_firstrow"><!-- --></A>
181<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
182  <TR ALIGN="center" VALIGN="top">
183  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
184  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
185  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
186  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RetryPolicy.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
187  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
188  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
189  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
190  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
191  </TR>
192</TABLE>
193</TD>
194<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
195</EM>
196</TD>
197</TR>
198
199<TR>
200<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
201&nbsp;<A HREF="../../../../../org/apache/hadoop/io/retry/RetryPolicies.html" title="class in org.apache.hadoop.io.retry"><B>PREV CLASS</B></A>&nbsp;
202&nbsp;<A HREF="../../../../../org/apache/hadoop/io/retry/RetryProxy.html" title="class in org.apache.hadoop.io.retry"><B>NEXT CLASS</B></A></FONT></TD>
203<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
204  <A HREF="../../../../../index.html?org/apache/hadoop/io/retry/RetryPolicy.html" target="_top"><B>FRAMES</B></A>  &nbsp;
205&nbsp;<A HREF="RetryPolicy.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
206&nbsp;<SCRIPT type="text/javascript">
207  <!--
208  if(window==top) {
209    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
210  }
211  //-->
212</SCRIPT>
213<NOSCRIPT>
214  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
215</NOSCRIPT>
216
217
218</FONT></TD>
219</TR>
220<TR>
221<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
222  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
223<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
224DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
225</TR>
226</TABLE>
227<A NAME="skip-navbar_bottom"></A>
228<!-- ======== END OF BOTTOM NAVBAR ======= -->
229
230<HR>
231Copyright &copy; 2009 The Apache Software Foundation
232</BODY>
233</HTML>
Note: See TracBrowser for help on using the repository browser.