inspectablepositionalcontainer.java

Java数据结构开发包

/*
  Copyright (c) 1999, 2000 Brown University, Providence, RI
  
                            All Rights Reserved
  
  Permission to use, copy, modify, and distribute this software and its
  documentation for any purpose other than its incorporation into a
  commercial product is hereby granted without fee, provided that the
  above copyright notice appear in all copies and that both that
  copyright notice and this permission notice appear in supporting
  documentation, and that the name of Brown University not be used in
  advertising or publicity pertaining to distribution of the software
  without specific, written prior permission.
  
  BROWN UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
  SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  FITNESS FOR ANY PARTICULAR PURPOSE.  IN NO EVENT SHALL BROWN
  UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  PERFORMANCE OF THIS SOFTWARE.
*/

package jdsl.core.api;



/**
 * Please refer to the documentation of
 * <code>PositionalContainer</code>.
 *
 * @see InspectableContainer
 * @see PositionalContainer
 * @version JDSL 2.1.1 
 * @author Mark Handy (mdh)
 * @author Andrew Schwerin (schwerin)
 * @author Luca Vismara (lv)
 */
public interface InspectablePositionalContainer extends InspectableContainer {
  
  /** 
   * Provides an iterator over all of the positions of the container. 
   * No order is specified.  However, certain implementations of
   * <code>PositionalContainer</code> may guarantee an order in which
   * the iterator iterates over the positions.  The iterator returned is a snapshot --
   * that is, it iterates over all positions that were in the container
   * at the moment that positions() was called, regardless of subsequent
   * modifications to the container.
   *
   * @return A PositionIterator over all positions in the container
   */
  public PositionIterator positions();

}