PageRenderTime 71ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/bsh/collection/CollectionIterator.html

#
HTML | 312 lines | 261 code | 39 blank | 12 comment | 0 complexity | e55f904f0159038efdef7941fec11772 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
  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_14) on Tue Jul 22 07:13:50 GMT-08:00 2008 -->
  6. <TITLE>
  7. CollectionIterator (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.bsh.collection.CollectionIterator class">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
  11. <NOSCRIPT>
  12. </NOSCRIPT>
  13. </HEAD>
  14. <BODY BGCOLOR="white" >
  15. <!-- ========= START OF TOP NAVBAR ======= -->
  16. <A NAME="navbar_top"><!-- --></A>
  17. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  18. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  19. <TR>
  20. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  21. <A NAME="navbar_top_firstrow"><!-- --></A>
  22. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  23. <TR ALIGN="center" VALIGN="top">
  24. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  25. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  26. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  27. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CollectionIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  28. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  29. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  30. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  31. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  32. </TR>
  33. </TABLE>
  34. </TD>
  35. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  36. </EM>
  37. </TD>
  38. </TR>
  39. <TR>
  40. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  41. &nbsp;PREV CLASS&nbsp;
  42. &nbsp;<A HREF="../../../../../../org/gjt/sp/jedit/bsh/collection/CollectionManagerImpl.html" title="class in org.gjt.sp.jedit.bsh.collection"><B>NEXT CLASS</B></A></FONT></TD>
  43. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  44. <A HREF="../../../../../../index.html?org/gjt/sp/jedit/bsh/collection/CollectionIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="CollectionIterator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  46. &nbsp;
  47. <NOSCRIPT>
  48. <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  49. </NOSCRIPT>
  50. </FONT></TD>
  51. </TR>
  52. <TR>
  53. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  54. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  55. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  56. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  57. </TR>
  58. </TABLE>
  59. <A NAME="skip-navbar_top"></A>
  60. <!-- ========= END OF TOP NAVBAR ========= -->
  61. <HR>
  62. <!-- ======== START OF CLASS DATA ======== -->
  63. <H2>
  64. <FONT SIZE="-1">
  65. org.gjt.sp.jedit.bsh.collection</FONT>
  66. <BR>
  67. Class CollectionIterator</H2>
  68. <PRE>
  69. java.lang.Object
  70. <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.bsh.collection.CollectionIterator</B>
  71. </PRE>
  72. <DL>
  73. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/gjt/sp/jedit/bsh/BshIterator.html" title="interface in org.gjt.sp.jedit.bsh">BshIterator</A></DD>
  74. </DL>
  75. <HR>
  76. <DL>
  77. <DT><PRE>public class <B>CollectionIterator</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../org/gjt/sp/jedit/bsh/BshIterator.html" title="interface in org.gjt.sp.jedit.bsh">BshIterator</A></DL>
  78. </PRE>
  79. <P>
  80. This is the implementation of:
  81. BshIterator - a dynamically loaded extension that supports the collections
  82. API supported by JDK1.2 and greater.
  83. <P>
  84. <P>
  85. <HR>
  86. <P>
  87. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  88. <A NAME="constructor_summary"><!-- --></A>
  89. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  90. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  91. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  92. <B>Constructor Summary</B></FONT></TH>
  93. </TR>
  94. <TR BGCOLOR="white" CLASS="TableRowColor">
  95. <TD><CODE><B><A HREF="../../../../../../org/gjt/sp/jedit/bsh/collection/CollectionIterator.html#CollectionIterator(java.lang.Object)">CollectionIterator</A></B>(java.lang.Object&nbsp;iterateOverMe)</CODE>
  96. <BR>
  97. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a basic CollectionIterator</TD>
  98. </TR>
  99. </TABLE>
  100. &nbsp;
  101. <!-- ========== METHOD SUMMARY =========== -->
  102. <A NAME="method_summary"><!-- --></A>
  103. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  104. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  105. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  106. <B>Method Summary</B></FONT></TH>
  107. </TR>
  108. <TR BGCOLOR="white" CLASS="TableRowColor">
  109. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  110. <CODE>protected &nbsp;java.util.Iterator</CODE></FONT></TD>
  111. <TD><CODE><B><A HREF="../../../../../../org/gjt/sp/jedit/bsh/collection/CollectionIterator.html#createIterator(java.lang.Object)">createIterator</A></B>(java.lang.Object&nbsp;iterateOverMe)</CODE>
  112. <BR>
  113. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an iterator over the given object</TD>
  114. </TR>
  115. <TR BGCOLOR="white" CLASS="TableRowColor">
  116. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  117. <CODE>&nbsp;boolean</CODE></FONT></TD>
  118. <TD><CODE><B><A HREF="../../../../../../org/gjt/sp/jedit/bsh/collection/CollectionIterator.html#hasNext()">hasNext</A></B>()</CODE>
  119. <BR>
  120. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if and only if there are more objects available
  121. via the <code>next()</code> method</TD>
  122. </TR>
  123. <TR BGCOLOR="white" CLASS="TableRowColor">
  124. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  125. <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
  126. <TD><CODE><B><A HREF="../../../../../../org/gjt/sp/jedit/bsh/collection/CollectionIterator.html#next()">next</A></B>()</CODE>
  127. <BR>
  128. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fetch the next object in the iteration</TD>
  129. </TR>
  130. </TABLE>
  131. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  132. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  133. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  134. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  135. </TR>
  136. <TR BGCOLOR="white" CLASS="TableRowColor">
  137. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  138. </TR>
  139. </TABLE>
  140. &nbsp;
  141. <P>
  142. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  143. <A NAME="constructor_detail"><!-- --></A>
  144. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  145. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  146. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  147. <B>Constructor Detail</B></FONT></TH>
  148. </TR>
  149. </TABLE>
  150. <A NAME="CollectionIterator(java.lang.Object)"><!-- --></A><H3>
  151. CollectionIterator</H3>
  152. <PRE>
  153. public <B>CollectionIterator</B>(java.lang.Object&nbsp;iterateOverMe)</PRE>
  154. <DL>
  155. <DD>Construct a basic CollectionIterator
  156. <P>
  157. <DL>
  158. <DT><B>Parameters:</B><DD><CODE>iterateOverMe</CODE> - The object over which we are iterating
  159. <DT><B>Throws:</B>
  160. <DD><CODE>java.lang.IllegalArgumentException</CODE> - If the argument is not a
  161. supported (i.e. iterable) type.
  162. <DD><CODE>java.lang.NullPointerException</CODE> - If the argument is null</DL>
  163. </DL>
  164. <!-- ============ METHOD DETAIL ========== -->
  165. <A NAME="method_detail"><!-- --></A>
  166. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  167. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  168. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  169. <B>Method Detail</B></FONT></TH>
  170. </TR>
  171. </TABLE>
  172. <A NAME="createIterator(java.lang.Object)"><!-- --></A><H3>
  173. createIterator</H3>
  174. <PRE>
  175. protected java.util.Iterator <B>createIterator</B>(java.lang.Object&nbsp;iterateOverMe)</PRE>
  176. <DL>
  177. <DD>Create an iterator over the given object
  178. <P>
  179. <DD><DL>
  180. </DL>
  181. </DD>
  182. <DD><DL>
  183. <DT><B>Parameters:</B><DD><CODE>iterateOverMe</CODE> - Object of type Iterator, Collection, or types
  184. supported by CollectionManager.BasicBshIterator
  185. <DT><B>Returns:</B><DD>an Iterator
  186. <DT><B>Throws:</B>
  187. <DD><CODE>java.lang.IllegalArgumentException</CODE> - If the argument is not a
  188. supported (i.e. iterable) type.
  189. <DD><CODE>java.lang.NullPointerException</CODE> - If the argument is null</DL>
  190. </DD>
  191. </DL>
  192. <HR>
  193. <A NAME="next()"><!-- --></A><H3>
  194. next</H3>
  195. <PRE>
  196. public java.lang.Object <B>next</B>()</PRE>
  197. <DL>
  198. <DD>Fetch the next object in the iteration
  199. <P>
  200. <DD><DL>
  201. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/gjt/sp/jedit/bsh/BshIterator.html#next()">next</A></CODE> in interface <CODE><A HREF="../../../../../../org/gjt/sp/jedit/bsh/BshIterator.html" title="interface in org.gjt.sp.jedit.bsh">BshIterator</A></CODE></DL>
  202. </DD>
  203. <DD><DL>
  204. <DT><B>Returns:</B><DD>The next object</DL>
  205. </DD>
  206. </DL>
  207. <HR>
  208. <A NAME="hasNext()"><!-- --></A><H3>
  209. hasNext</H3>
  210. <PRE>
  211. public boolean <B>hasNext</B>()</PRE>
  212. <DL>
  213. <DD>Returns true if and only if there are more objects available
  214. via the <code>next()</code> method
  215. <P>
  216. <DD><DL>
  217. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/gjt/sp/jedit/bsh/BshIterator.html#hasNext()">hasNext</A></CODE> in interface <CODE><A HREF="../../../../../../org/gjt/sp/jedit/bsh/BshIterator.html" title="interface in org.gjt.sp.jedit.bsh">BshIterator</A></CODE></DL>
  218. </DD>
  219. <DD><DL>
  220. <DT><B>Returns:</B><DD>The next object</DL>
  221. </DD>
  222. </DL>
  223. <!-- ========= END OF CLASS DATA ========= -->
  224. <HR>
  225. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  226. <A NAME="navbar_bottom"><!-- --></A>
  227. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  228. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  229. <TR>
  230. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  231. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  232. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  233. <TR ALIGN="center" VALIGN="top">
  234. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  235. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  236. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  237. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CollectionIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  238. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  239. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  240. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  241. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  242. </TR>
  243. </TABLE>
  244. </TD>
  245. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  246. </EM>
  247. </TD>
  248. </TR>
  249. <TR>
  250. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  251. &nbsp;PREV CLASS&nbsp;
  252. &nbsp;<A HREF="../../../../../../org/gjt/sp/jedit/bsh/collection/CollectionManagerImpl.html" title="class in org.gjt.sp.jedit.bsh.collection"><B>NEXT CLASS</B></A></FONT></TD>
  253. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  254. <A HREF="../../../../../../index.html?org/gjt/sp/jedit/bsh/collection/CollectionIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
  255. &nbsp;<A HREF="CollectionIterator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  256. &nbsp;
  257. <NOSCRIPT>
  258. <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  259. </NOSCRIPT>
  260. </FONT></TD>
  261. </TR>
  262. <TR>
  263. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  264. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  265. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  266. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  267. </TR>
  268. </TABLE>
  269. <A NAME="skip-navbar_bottom"></A>
  270. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  271. <HR>
  272. </BODY>
  273. </HTML>