001/*
002 * Copyright 2010-2015 Institut Pasteur.
003 * 
004 * This file is part of Icy.
005 * 
006 * Icy is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 * 
011 * Icy is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014 * GNU General Public License for more details.
015 * 
016 * You should have received a copy of the GNU General Public License
017 * along with Icy. If not, see <http://www.gnu.org/licenses/>.
018 */
019package icy.type;
020
021import java.util.NoSuchElementException;
022
023/**
024 * Data iterator interface.<br>
025 * This interface provides iteration for both read and write operation on double data.<br>
026 * 
027 * @author Stephane
028 */
029public interface DataIterator
030{
031    /**
032     * Reset iterator to initial position.
033     */
034    public void reset();
035
036    /**
037     * Pass to the next element.
038     */
039    public void next();
040
041    /**
042     * Returns <tt>true</tt> if the iterator has no more elements.
043     */
044    public boolean done();
045
046    /**
047     * Returns the current element in the iteration.
048     * 
049     * @return the current element in the iteration.
050     * @exception NoSuchElementException
051     *            iteration has no more elements.
052     */
053    public double get();
054
055    /**
056     * Sets the current element in the iteration and pass to the next.
057     * 
058     * @exception NoSuchElementException
059     *            iteration has no more elements.
060     */
061    public void set(double value);
062}