ozonelistiterator.java

Java的面向对象数据库系统的源代码

// You can redistribute this software and/or modify it under the terms of
// the Ozone Library License version 1 published by ozone-db.org.
//
// This file is
// Copyright (C) 2002-@year@ Leo Mekenkamp. All rights reserved.
// $Id: OzoneListIterator.java,v 1.2 2003/01/27 17:41:36 leomekenkamp Exp $

package org.ozoneDB.collections;

import java.util.ListIterator;

/**
 * See the overall description on {@link org.ozoneDB.collections.OzoneCollection}.
 * @author <a href="mailto:ozoneATmekenkampD0Tcom">Leo Mekenkamp (mind the anti-sp@m)</a>
 */
public interface OzoneListIterator extends ListIterator, OzoneIterator {

    /** Returns the previous element in the list.  This method may be called
     * repeatedly to iterate through the list backwards, or intermixed with
     * calls to <tt>next</tt> to go back and forth.  (Note that alternating
     * calls to <tt>next</tt> and <tt>previous</tt> will return the same
     * element repeatedly.)
     *
     * @return the previous element in the list.
     *
     * @exception java.util.NoSuchElementException if the iteration has no previous
     *            element.
     *
     */
    public Object previous(); /*update*/

    /** Inserts the specified element into the list (optional operation).  The
     * element is inserted immediately before the next element that would be
     * returned by <tt>next</tt>, if any, and after the next element that
     * would be returned by <tt>previous</tt>, if any.  (If the list contains
     * no elements, the new element becomes the sole element on the list.)
     * The new element is inserted before the implicit cursor: a subsequent
     * call to <tt>next</tt> would be unaffected, and a subsequent call to
     * <tt>previous</tt> would return the new element.  (This call increases
     * by one the value that would be returned by a call to <tt>nextIndex</tt>
     * or <tt>previousIndex</tt>.)
     *
     * @param o the element to insert.
     * @exception UnsupportedOperationException if the <tt>add</tt> method is
     * 		  not supported by this list iterator.
     *
     * @exception ClassCastException if the class of the specified element
     * 		  prevents it from being added to this list.
     *
     * @exception IllegalArgumentException if some aspect of this element
     *            prevents it from being added to this list.
     *
     */
    public void add(Object o); /*update*/

}