source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/mapred/join/StreamBackedIterator.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: 25.7 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:57 UTC 2009 -->
6<TITLE>
7StreamBackedIterator (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="StreamBackedIterator (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/StreamBackedIterator.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/mapred/join/ResetableIterator.EMPTY.html" title="class in org.apache.hadoop.mapred.join"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/hadoop/mapred/join/TupleWritable.html" title="class in org.apache.hadoop.mapred.join"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/hadoop/mapred/join/StreamBackedIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="StreamBackedIterator.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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.mapred.join</FONT>
92<BR>
93Class StreamBackedIterator&lt;X extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</H2>
94<PRE>
95<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.mapred.join.StreamBackedIterator&lt;X&gt;</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;X&gt;</DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>StreamBackedIterator&lt;X extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;X&gt;</DL>
104</PRE>
105
106<P>
107This class provides an implementation of ResetableIterator. This
108 implementation uses a byte array to store elements added to it.
109<P>
110
111<P>
112<HR>
113
114<P>
115<!-- ======== NESTED CLASS SUMMARY ======== -->
116
117<A NAME="nested_class_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Nested Class Summary</B></FONT></TH>
122</TR>
123</TABLE>
124&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.hadoop.mapred.join.ResetableIterator"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
127<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.hadoop.mapred.join.<A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A></B></TH>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.EMPTY.html" title="class in org.apache.hadoop.mapred.join">ResetableIterator.EMPTY</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.EMPTY.html" title="type parameter in ResetableIterator.EMPTY">U</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></TD>
131</TR>
132</TABLE>
133&nbsp;
134
135<!-- ======== CONSTRUCTOR SUMMARY ======== -->
136
137<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#StreamBackedIterator()">StreamBackedIterator</A></B>()</CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148</TR>
149</TABLE>
150&nbsp;
151<!-- ========== METHOD SUMMARY =========== -->
152
153<A NAME="method_summary"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
156<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
157<B>Method Summary</B></FONT></TH>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;void</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#add(X)">add</A></B>(<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A>&nbsp;item)</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an element to the collection of elements to iterate over.</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#clear()">clear</A></B>()</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close datasources, but do not release internal resources.</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;void</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#close()">close</A></B>()</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close datasources and release resources.</TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>&nbsp;boolean</CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#hasNext()">hasNext</A></B>()</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if a call to next may return a value.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>&nbsp;boolean</CODE></FONT></TD>
194<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#next(X)">next</A></B>(<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A>&nbsp;val)</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assign next value to actual.</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>&nbsp;boolean</CODE></FONT></TD>
202<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#replay(X)">replay</A></B>(<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A>&nbsp;val)</CODE>
203
204<BR>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assign last value returned to actual.</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;void</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html#reset()">reset</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set iterator to return to the start of its range.</TD>
214</TR>
215</TABLE>
216&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
219<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
223</TR>
224</TABLE>
225&nbsp;
226<P>
227
228<!-- ========= CONSTRUCTOR DETAIL ======== -->
229
230<A NAME="constructor_detail"><!-- --></A>
231<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
232<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
233<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
234<B>Constructor Detail</B></FONT></TH>
235</TR>
236</TABLE>
237
238<A NAME="StreamBackedIterator()"><!-- --></A><H3>
239StreamBackedIterator</H3>
240<PRE>
241public <B>StreamBackedIterator</B>()</PRE>
242<DL>
243</DL>
244
245<!-- ============ METHOD DETAIL ========== -->
246
247<A NAME="method_detail"><!-- --></A>
248<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
249<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
250<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
251<B>Method Detail</B></FONT></TH>
252</TR>
253</TABLE>
254
255<A NAME="hasNext()"><!-- --></A><H3>
256hasNext</H3>
257<PRE>
258public boolean <B>hasNext</B>()</PRE>
259<DL>
260<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#hasNext()">ResetableIterator</A></CODE></B></DD>
261<DD>True if a call to next may return a value. This is permitted false
262 positives, but not false negatives.
263<P>
264<DD><DL>
265<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#hasNext()">hasNext</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></DL>
266</DD>
267<DD><DL>
268</DL>
269</DD>
270</DL>
271<HR>
272
273<A NAME="next(org.apache.hadoop.io.Writable)"><!-- --></A><A NAME="next(X)"><!-- --></A><H3>
274next</H3>
275<PRE>
276public boolean <B>next</B>(<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A>&nbsp;val)
277             throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
278<DL>
279<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#next(T)">ResetableIterator</A></CODE></B></DD>
280<DD>Assign next value to actual.
281 It is required that elements added to a ResetableIterator be returned in
282 the same order after a call to <A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#reset()"><CODE>ResetableIterator.reset()</CODE></A> (FIFO).
283
284 Note that a call to this may fail for nested joins (i.e. more elements
285 available, but none satisfying the constraints of the join)
286<P>
287<DD><DL>
288<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#next(T)">next</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></DL>
289</DD>
290<DD><DL>
291
292<DT><B>Throws:</B>
293<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
294</DD>
295</DL>
296<HR>
297
298<A NAME="replay(org.apache.hadoop.io.Writable)"><!-- --></A><A NAME="replay(X)"><!-- --></A><H3>
299replay</H3>
300<PRE>
301public boolean <B>replay</B>(<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A>&nbsp;val)
302               throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
303<DL>
304<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#replay(T)">ResetableIterator</A></CODE></B></DD>
305<DD>Assign last value returned to actual.
306<P>
307<DD><DL>
308<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#replay(T)">replay</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></DL>
309</DD>
310<DD><DL>
311
312<DT><B>Throws:</B>
313<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
314</DD>
315</DL>
316<HR>
317
318<A NAME="reset()"><!-- --></A><H3>
319reset</H3>
320<PRE>
321public void <B>reset</B>()</PRE>
322<DL>
323<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#reset()">ResetableIterator</A></CODE></B></DD>
324<DD>Set iterator to return to the start of its range. Must be called after
325 calling <A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#add(T)"><CODE>ResetableIterator.add(T)</CODE></A> to avoid a ConcurrentModificationException.
326<P>
327<DD><DL>
328<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></DL>
329</DD>
330<DD><DL>
331</DL>
332</DD>
333</DL>
334<HR>
335
336<A NAME="add(org.apache.hadoop.io.Writable)"><!-- --></A><A NAME="add(X)"><!-- --></A><H3>
337add</H3>
338<PRE>
339public void <B>add</B>(<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A>&nbsp;item)
340         throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
341<DL>
342<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#add(T)">ResetableIterator</A></CODE></B></DD>
343<DD>Add an element to the collection of elements to iterate over.
344<P>
345<DD><DL>
346<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#add(T)">add</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></DL>
347</DD>
348<DD><DL>
349
350<DT><B>Throws:</B>
351<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
352</DD>
353</DL>
354<HR>
355
356<A NAME="close()"><!-- --></A><H3>
357close</H3>
358<PRE>
359public void <B>close</B>()
360           throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
361<DL>
362<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#close()">ResetableIterator</A></CODE></B></DD>
363<DD>Close datasources and release resources. Calling methods on the iterator
364 after calling close has undefined behavior.
365<P>
366<DD><DL>
367<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></DL>
368</DD>
369<DD><DL>
370
371<DT><B>Throws:</B>
372<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
373</DD>
374</DL>
375<HR>
376
377<A NAME="clear()"><!-- --></A><H3>
378clear</H3>
379<PRE>
380public void <B>clear</B>()</PRE>
381<DL>
382<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#clear()">ResetableIterator</A></CODE></B></DD>
383<DD>Close datasources, but do not release internal resources. Calling this
384 method should permit the object to be reused with a different datasource.
385<P>
386<DD><DL>
387<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html#clear()">clear</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.html" title="interface in org.apache.hadoop.mapred.join">ResetableIterator</A>&lt;<A HREF="../../../../../org/apache/hadoop/mapred/join/StreamBackedIterator.html" title="type parameter in StreamBackedIterator">X</A> extends <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&gt;</CODE></DL>
388</DD>
389<DD><DL>
390</DL>
391</DD>
392</DL>
393<!-- ========= END OF CLASS DATA ========= -->
394<HR>
395
396
397<!-- ======= START OF BOTTOM NAVBAR ====== -->
398<A NAME="navbar_bottom"><!-- --></A>
399<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
400<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
401<TR>
402<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
403<A NAME="navbar_bottom_firstrow"><!-- --></A>
404<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
405  <TR ALIGN="center" VALIGN="top">
406  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
407  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
408  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
409  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StreamBackedIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
410  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
411  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
412  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
413  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
414  </TR>
415</TABLE>
416</TD>
417<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
418</EM>
419</TD>
420</TR>
421
422<TR>
423<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
424&nbsp;<A HREF="../../../../../org/apache/hadoop/mapred/join/ResetableIterator.EMPTY.html" title="class in org.apache.hadoop.mapred.join"><B>PREV CLASS</B></A>&nbsp;
425&nbsp;<A HREF="../../../../../org/apache/hadoop/mapred/join/TupleWritable.html" title="class in org.apache.hadoop.mapred.join"><B>NEXT CLASS</B></A></FONT></TD>
426<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
427  <A HREF="../../../../../index.html?org/apache/hadoop/mapred/join/StreamBackedIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
428&nbsp;<A HREF="StreamBackedIterator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
429&nbsp;<SCRIPT type="text/javascript">
430  <!--
431  if(window==top) {
432    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
433  }
434  //-->
435</SCRIPT>
436<NOSCRIPT>
437  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
438</NOSCRIPT>
439
440
441</FONT></TD>
442</TR>
443<TR>
444<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
445  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
446<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
447DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
448</TR>
449</TABLE>
450<A NAME="skip-navbar_bottom"></A>
451<!-- ======== END OF BOTTOM NAVBAR ======= -->
452
453<HR>
454Copyright &copy; 2009 The Apache Software Foundation
455</BODY>
456</HTML>
Note: See TracBrowser for help on using the repository browser.