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-google-internal) on Mon Jan 04 20:47:57 PST 2010 --> 6 <TITLE> 7 ForwardingIterator (Guava Libraries 2010.01.04) 8 </TITLE> 9 10 <META NAME="date" CONTENT="2010-01-04"> 11 12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 13 14 <SCRIPT type="text/javascript"> 15 function windowTitle() 16 { 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="ForwardingIterator (Guava Libraries 2010.01.04)"; 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> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForwardingIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 <A HREF="../../../../com/google/common/collect/ForwardingConcurrentMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD> 60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/google/common/collect/ForwardingIterator.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="ForwardingIterator.html" target="_top"><B>NO FRAMES</B></A> 63 <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> 91 com.google.common.collect</FONT> 92 <BR> 93 Class ForwardingIterator<T></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 "><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">com.google.common.collect.ForwardingObject</A> 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.ForwardingIterator<T></B> 98 </PRE> 99 <DL> 100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><T></DD> 101 </DL> 102 <DL> 103 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/google/common/collect/ForwardingListIterator.html" title="class in com.google.common.collect">ForwardingListIterator</A></DD> 104 </DL> 105 <HR> 106 <DL> 107 <DT><PRE>public abstract class <B>ForwardingIterator<T></B><DT>extends <A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A><DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><T></DL> 108 </PRE> 109 110 <P> 111 An iterator which forwards all its method calls to another iterator. 112 Subclasses should override one or more methods to modify the behavior of the 113 backing iterator as desired per the <a 114 href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>. 115 <P> 116 117 <P> 118 <DL> 119 <DT><B>Since:</B></DT> 120 <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD> 121 <DT><B>Author:</B></DT> 122 <DD>Kevin Bourrillion</DD> 123 <DT><B>See Also:</B><DD><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><CODE>ForwardingObject</CODE></A></DL> 124 <HR> 125 126 <P> 127 128 <!-- ======== CONSTRUCTOR SUMMARY ======== --> 129 130 <A NAME="constructor_summary"><!-- --></A> 131 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 132 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 133 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 134 <B>Constructor Summary</B></FONT></TH> 135 </TR> 136 <TR BGCOLOR="white" CLASS="TableRowColor"> 137 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingIterator.html#ForwardingIterator()">ForwardingIterator</A></B>()</CODE> 138 139 <BR> 140 </TD> 141 </TR> 142 </TABLE> 143 144 <!-- ========== METHOD SUMMARY =========== --> 145 146 <A NAME="method_summary"><!-- --></A> 147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 148 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 149 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 150 <B>Method Summary</B></FONT></TH> 151 </TR> 152 <TR BGCOLOR="white" CLASS="TableRowColor"> 153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 154 <CODE>protected abstract <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="type parameter in ForwardingIterator">T</A>></CODE></FONT></TD> 155 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingIterator.html#delegate()">delegate</A></B>()</CODE> 156 157 <BR> 158 Returns the backing delegate instance that methods are forwarded to.</TD> 159 </TR> 160 <TR BGCOLOR="white" CLASS="TableRowColor"> 161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 162 <CODE> boolean</CODE></FONT></TD> 163 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingIterator.html#hasNext()">hasNext</A></B>()</CODE> 164 165 <BR> 166 </TD> 167 </TR> 168 <TR BGCOLOR="white" CLASS="TableRowColor"> 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 170 <CODE> <A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="type parameter in ForwardingIterator">T</A></CODE></FONT></TD> 171 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingIterator.html#next()">next</A></B>()</CODE> 172 173 <BR> 174 </TD> 175 </TR> 176 <TR BGCOLOR="white" CLASS="TableRowColor"> 177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 178 <CODE> void</CODE></FONT></TD> 179 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingIterator.html#remove()">remove</A></B>()</CODE> 180 181 <BR> 182 </TD> 183 </TR> 184 </TABLE> 185 <A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingObject"><!-- --></A> 186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 187 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 188 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A></B></TH> 189 </TR> 190 <TR BGCOLOR="white" CLASS="TableRowColor"> 191 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#toString()">toString</A></CODE></TD> 192 </TR> 193 </TABLE> 194 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 195 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 196 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 197 <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> 198 </TR> 199 <TR BGCOLOR="white" CLASS="TableRowColor"> 200 <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#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> 201 </TR> 202 </TABLE> 203 204 <P> 205 206 <!-- ========= CONSTRUCTOR DETAIL ======== --> 207 208 <A NAME="constructor_detail"><!-- --></A> 209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 211 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 212 <B>Constructor Detail</B></FONT></TH> 213 </TR> 214 </TABLE> 215 216 <A NAME="ForwardingIterator()"><!-- --></A><H3> 217 ForwardingIterator</H3> 218 <PRE> 219 public <B>ForwardingIterator</B>()</PRE> 220 <DL> 221 </DL> 222 223 <!-- ============ METHOD DETAIL ========== --> 224 225 <A NAME="method_detail"><!-- --></A> 226 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 227 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 228 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 229 <B>Method Detail</B></FONT></TH> 230 </TR> 231 </TABLE> 232 233 <A NAME="delegate()"><!-- --></A><H3> 234 delegate</H3> 235 <PRE> 236 protected abstract <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="type parameter in ForwardingIterator">T</A>> <B>delegate</B>()</PRE> 237 <DL> 238 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">ForwardingObject</A></CODE></B></DD> 239 <DD>Returns the backing delegate instance that methods are forwarded to. 240 Abstract subclasses generally override this method with an abstract method 241 that has a more specific return type, such as <A HREF="../../../../com/google/common/collect/ForwardingSet.html#delegate()"><CODE>ForwardingSet.delegate()</CODE></A>. Concrete subclasses override this method to supply 242 the instance being decorated. 243 <P> 244 <DD><DL> 245 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">delegate</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A></CODE></DL> 246 </DD> 247 <DD><DL> 248 </DL> 249 </DD> 250 </DL> 251 <HR> 252 253 <A NAME="hasNext()"><!-- --></A><H3> 254 hasNext</H3> 255 <PRE> 256 public boolean <B>hasNext</B>()</PRE> 257 <DL> 258 <DD><DL> 259 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#hasNext()" title="class or interface in java.util">hasNext</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="type parameter in ForwardingIterator">T</A>></CODE></DL> 260 </DD> 261 <DD><DL> 262 </DL> 263 </DD> 264 </DL> 265 <HR> 266 267 <A NAME="next()"><!-- --></A><H3> 268 next</H3> 269 <PRE> 270 public <A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="type parameter in ForwardingIterator">T</A> <B>next</B>()</PRE> 271 <DL> 272 <DD><DL> 273 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util">next</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="type parameter in ForwardingIterator">T</A>></CODE></DL> 274 </DD> 275 <DD><DL> 276 </DL> 277 </DD> 278 </DL> 279 <HR> 280 281 <A NAME="remove()"><!-- --></A><H3> 282 remove</H3> 283 <PRE> 284 public void <B>remove</B>()</PRE> 285 <DL> 286 <DD><DL> 287 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#remove()" title="class or interface in java.util">remove</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../com/google/common/collect/ForwardingIterator.html" title="type parameter in ForwardingIterator">T</A>></CODE></DL> 288 </DD> 289 <DD><DL> 290 </DL> 291 </DD> 292 </DL> 293 <!-- ========= END OF CLASS DATA ========= --> 294 <HR> 295 296 297 <!-- ======= START OF BOTTOM NAVBAR ====== --> 298 <A NAME="navbar_bottom"><!-- --></A> 299 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 300 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 301 <TR> 302 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 303 <A NAME="navbar_bottom_firstrow"><!-- --></A> 304 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 305 <TR ALIGN="center" VALIGN="top"> 306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 307 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 308 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForwardingIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 314 </TR> 315 </TABLE> 316 </TD> 317 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 318 </EM> 319 </TD> 320 </TR> 321 322 <TR> 323 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 324 <A HREF="../../../../com/google/common/collect/ForwardingConcurrentMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 325 <A HREF="../../../../com/google/common/collect/ForwardingList.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD> 326 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 327 <A HREF="../../../../index.html?com/google/common/collect/ForwardingIterator.html" target="_top"><B>FRAMES</B></A> 328 <A HREF="ForwardingIterator.html" target="_top"><B>NO FRAMES</B></A> 329 <SCRIPT type="text/javascript"> 330 <!-- 331 if(window==top) { 332 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 333 } 334 //--> 335 </SCRIPT> 336 <NOSCRIPT> 337 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 338 </NOSCRIPT> 339 340 341 </FONT></TD> 342 </TR> 343 <TR> 344 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 345 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 346 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 347 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 348 </TR> 349 </TABLE> 350 <A NAME="skip-navbar_bottom"></A> 351 <!-- ======== END OF BOTTOM NAVBAR ======= --> 352 353 <HR> 354 355 </BODY> 356 </HTML> 357
