soot.util.Chain Maven / Gradle / Ivy
/* Soot - a J*va Optimization Framework
* Copyright (C) 1999 Patrice Pominville
*
* 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/*
* Modified by the Sable Research Group and others 1997-1999.
* See the 'credits' file distributed with Soot for the complete list of
* contributors. (Soot is distributed at http://www.sable.mcgill.ca/soot)
*/
package soot.util;
import java.io.Serializable;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
/** Augmented data type guaranteeing O(1) insertion and removal from a set
* of ordered, unique elements.
* @param element type */
public interface Chain extends Collection, Serializable
{
/** Inserts toInsert in the Chain before point. */
public void insertBefore(List toInsert, E point);
/** Inserts toInsert in the Chain after point. */
public void insertAfter(List toInsert, E point);
/** Inserts toInsert in the Chain after point. */
public void insertAfter(E toInsert, E point);
/** Inserts toInsert in the Chain before point. */
public void insertBefore(E toInsert, E point);
/** Inserts toInsert in the Chain before point.
* (It would probably be better to make Chain implement List)*/
public void insertBefore(Chain toInsert, E point);
/** Inserts toInsert in the Chain after point.
* (It would probably be better to make Chain implement List)*/
public void insertAfter(Chain toInsert, E point);
/** Replaces out in the Chain by in. */
public void swapWith(E out, E in);
/** Removes the given object from this Chain.
* Parameter has to be of type {@link Object} to be compatible
* with the {@link Collection} interface. */
public boolean remove(Object u);
/** Adds the given object at the beginning of the Chain. */
public void addFirst(E u);
/** Adds the given object at the end of the Chain. */
public void addLast(E u);
/** Removes the first object contained in this Chain. */
public void removeFirst();
/** Removes the last object contained in this Chain. */
public void removeLast();
/** Returns true if object someObject follows object someReferenceObject in the Chain. */
public boolean follows(E someObject, E someReferenceObject);
/** Returns the first object in this Chain. */
public E getFirst();
/** Returns the last object in this Chain. */
public E getLast();
/** Returns the object immediately following point. */
public E getSuccOf(E point);
/** Returns the object immediately preceding point. */
public E getPredOf(E point);
/** Returns an iterator over a copy of this chain.
* This avoids ConcurrentModificationExceptions from being thrown
* if the underlying Chain is modified during iteration.
* Do not use this to remove elements which have not yet been
* iterated over! */
public Iterator snapshotIterator();
/** Returns an iterator over this Chain. */
public Iterator iterator();
/** Returns an iterator over this Chain, starting at the given object. */
public Iterator iterator(E u);
/** Returns an iterator over this Chain, starting at head and reaching tail (inclusive). */
public Iterator iterator(E head, E tail);
/** Returns the size of this Chain. */
public int size();
}