/*
	Netwar
	Copyright (C) 2002  Daniel Grund, Kyle Kakligian, Jason Komutrattananon, & Brian Hibler.

	This file is part of Netwar.

	Netwar is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	Netwar 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 General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with Netwar; if not, write to the Free Software
	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package netwar.utils;

/** A Queue ADT
 * @author Kyle Kakligian
 */
public interface Queue {
/** Clears the queue.
 */
	public void clear();
        /** Enqueues an Object.
         * @param it The Object to enqueue.
         */
	public void enqueue(Object it);
        /** Dequeues an Object.
         * @return The dequeued Object.
         */
	public Object dequeue();
        /** Peeks at the next Object to dequeue.
         * @return The next Object to dequeue.
         */
	public Object peek();
        /** Returns whether or not the queue is empty.
         * @return true if empty.
         */
	public boolean isEmpty();
/** Internally shrinks the memory footprint.
 */
	public void shrink();
        /** Internally resizes the queue to hold at least the given number of items
         * @param sz The minimun number of Objects for the queue.
         */
	public void resize(int sz);
}