ReadOnlyIterator.java

/*
 *  Jajuk
 *  Copyright (C) The Jajuk Team
 *  http://jajuk.info
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *  
 */
package org.jajuk.util;

import java.util.Iterator;

/**
 * A convenient class that prevents remove() method from an iterator <br>
 * Generic class.
 *
 * @param <V> 
 */
public class ReadOnlyIterator<V> {
  /** Managed iterator *. */
  Iterator<V> iterator;

  /**
   * Instantiates a new read only iterator.
   * 
   * @param it The source iterator that should be wrapped.
   */
  public ReadOnlyIterator(Iterator<V> it) {
    this.iterator = it;
  }

  /**
   * Return the next value from the iterator.
   * 
   * @return The next element from the collection.
   */
  public V next() {
    return iterator.next();
  }

  /**
   * Checks if there is another element in the collection.
   * 
   * @return true if there is another element, false otherwise.
   */
  public boolean hasNext() {
    return iterator.hasNext();
  }
}