package containers;

import java.util.Enumeration;

import ordered.IOrdered;

/**
 * An abstract ordered container.
 *
 * Version 1.
 *
 * @author Alan L. Cox
 * @since 03/21/01
 */
public interface IOrderedContainer {

    /**
     * If there is an object associated with key
     * then this object is returned else null is returned.
     */
    public Object find(IOrdered key);

    /**
     * Afterwards, find(key) returns null, and if there is
     * an object associated with key then this object is
     * returned else null is returned.
     */
    public Object remove(IOrdered key);

    /**
     * (key, value) is stored in this container with no
     * duplication and such that find(key) returns value.
     */
    public void insert(IOrdered key, Object value);

    /**
     * Returns an Enumeration of the container.
     */
    public Enumeration enumeration();
}