Java Doc for LoopingIterator.java in  » Library » Apache-common-Collections » org » apache » commons » collections » iterators » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The iterator will loop continuously around the provided elements, unless there are no elements in the collection to begin with, or all the elements have been LoopingIterator.remove removed .

Concurrent modifications are not directly supported, and for most collection implementations will throw a ConcurrentModificationException.
since:
   Commons Collections 3.0
version:
   $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
   Jonathan Carlson
author:
   Stephen Colebourne

If at the end of the collection, return the first element.
throws:
  NoSuchElementException - if there are no elementsat all.

This feature is only supported if the underlying collection's Collection.iterator iterator method returns an implementation that supports it.

This method can only be called after at least one LoopingIterator.next method call. After a removal, the remove method may not be called again until another next has been performed.

There is no way to reset an Iterator instance without recreating it from the original source, so the Collection must be passed in.
Parameters:
  coll - the collection to wrap
throws:
  NullPointerException - if the collection is null

Returns false only if the collection originally had zero elements, or all the elements have been LoopingIterator.remove removed . true if there are more elements

If at the end of the collection, return the first element.
throws:
  NoSuchElementException - if there are no elementsat all. Use LoopingIterator.hasNext to avoid this error.

This feature is only supported if the underlying collection's Collection.iterator iterator method returns an implementation that supports it.

This method can only be called after at least one LoopingIterator.next method call. After a removal, the remove method may not be called again until another next has been performed. If the LoopingIterator.reset is called, then remove may not be called until LoopingIterator.next is called again.