Protects an given iterator by preventing calls to remove().

    
/* 
 * JCommon : a free general purpose class library for the Java(tm) platform
 * 
 *
 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
 * 
 * Project Info:  http://www.jfree.org/jcommon/index.html
 *
 * This library is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by 
 * the Free Software Foundation; either version 2.1 of the License, or 
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
 * USA.  
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
 * in the United States and other countries.]
 * 
 * ---------------------
 * ReadOnlyIterator.java
 * ---------------------
 * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   -;
 *
 * $Id: ReadOnlyIterator.java,v 1.2 2005/10/18 13:24:19 mungady Exp $
 *
 * Changes
 * -------------------------
 * 18-Jul-2003 : Initial version
 *
 */

import java.util.Iterator;

/**
 * Protects an given iterator by preventing calls to remove().
 *
 * @author Thomas Morgner
 */
public class ReadOnlyIterator implements Iterator {

    /** The base iterator which we protect. */
    private Iterator base;

    /**
     * Creates a new read-only iterator for the given iterator.
     *
     * @param it the iterator.
     */
    public ReadOnlyIterator(final Iterator it) {
        if (it == null) {
            throw new NullPointerException("Base iterator is null.");
        }
        this.base = it;
    }

    /**
     * Returns <tt>true</tt> if the iteration has more elements. (In other
     * words, returns <tt>true</tt> if <tt>next</tt> would return an element
     * rather than throwing an exception.)
     *
     * @return <tt>true</tt> if the iterator has more elements.
     */
    public boolean hasNext() {
        return this.base.hasNext();
    }

    /**
     * Returns the next element in the iteration.
     * Throws NoSuchElementException when iteration has no more elements.
     * 
     * @return the next element in the iteration.
     */
    public Object next() {
        return this.base.next();
    }

    /**
     * Throws <code>UnsupportedOperationException</code>.
     */
    public void remove() {
        throw new UnsupportedOperationException();
    }
}

Related examples in the same category

1.	Listing the Elements of a Collection
2.	De-mystify the Iterator interface, showing how to write a simple Iterator for an Array of Objects
3.	Iterate over Set
4.	Demonstrate iterators.
5.	Use the for-each for loop to cycle through a collection.
6.	List Iterator
7.	Iterate a Collection and remove an item (Exception, wrong version)
8.	Use an Iterator and remove the item with Iterator.remove()
9.	An Iterator wrapper for an Enumeration.
10.	EmptyIterator is an iterator which is empty.
11.	Implements an java.util.Iterator over any array
12.	Treat an Iterator as an Iterable
13.	Iterator class for sparse values in an array.
14.	Iterator class for values contained in an array range.
15.	Array Iterator
16.	Cyclic Iteration
17.	Create singleton Iterator
18.	Empty Iterator
19.	An Iterator that wraps a number of Iterators
20.	An Iterator to iterate over the elements of an array
21.	Sorted Iterator
22.	Iterator Union of Iterators
23.	Iterator Utils
24.	Linked Iterator
25.	Prefetch Iterator
26.	An Iterator that returns the elements of a specified array, or other iterators etc.
27.	An Iterator wrapper for an Object[], allow us to deal with all array like structures in a consistent manner.
28.	An array iterator
29.	Adapt iterator to iterable
30.	Static utility methods, classes, and abstract classes for iteration.
31.	Iterator Collection
32.	Convert Iterable to List
33.	A singleton null object Iterator implementation.

Protects an given iterator by preventing calls to remove(). : Iterator « Collections Data Structure « Java

Related examples in the same category