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