Package org.apache.commons.collections.iterators

Class SingletonIterator

  • All Implemented Interfaces:
    Iterator, ResettableIterator
    public class SingletonIterator
extends Object
implements Iterator, ResettableIterator
    SingletonIterator is an Iterator over a single object instance.
    Since:
    Commons Collections 2.0
    Version:
    $Revision: 647116 $ $Date: 2008-04-11 13:23:08 +0200 (Fri, 11 Apr 2008) $
    Author:
    James Strachan, Stephen Colebourne, Rodney Waldhoff

    • Constructor Detail

      • SingletonIterator

        public SingletonIterator​(Object object)
        Constructs a new SingletonIterator where remove is a permitted operation.
        Parameters:
        object - the single object to return from the iterator

      • SingletonIterator

        public SingletonIterator​(Object object,
                         boolean removeAllowed)
        Constructs a new SingletonIterator optionally choosing if remove is a permitted operation.
        Parameters:
        object - the single object to return from the iterator
        removeAllowed - true if remove is allowed
        Since:
        Commons Collections 3.1

    • Method Detail

      • hasNext

        public boolean hasNext()
        Is another object available from the iterator?

        This returns true if the single object hasn't been returned yet.

        Specified by:
        hasNext in interface Iterator
        Returns:
        true if the single object hasn't been returned yet

      • next

        public Object next()
        Get the next object from the iterator.

        This returns the single object if it hasn't been returned yet.

        Specified by:
        next in interface Iterator
        Returns:
        the single object
        Throws:
        NoSuchElementException - if the single object has already been returned

      • remove

        public void remove()
        Remove the object from this iterator.
        Specified by:
        remove in interface Iterator
        Throws:
        IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.
        UnsupportedOperationException - if remove is not supported

      • reset

        public void reset()
        Reset the iterator to the start.
        Specified by:
        reset in interface ResettableIterator