ISimpleFIFOQueue.java

/*******************************************************************************
 * Copyright (c) 2004 Composent, Inc. and others. All rights reserved. This
 * program and the accompanying materials are made available under the terms of
 * the Eclipse Public License v1.0 which accompanies this distribution, and is
 * available at http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Composent, Inc. - initial API and implementation
 ******************************************************************************/
package org.eclipse.ecf.core.sharedobject.util;

/**
 * Simple queue
 * 
 */
public interface ISimpleFIFOQueue {
	/**
	 * Enqueue given object. Blocks until enqueue is completed.
	 * 
	 * @param obj
	 *            the Object to enqueue
	 * @return true if enqueued, false if not successfully enqueue
	 */
	public boolean enqueue(Object obj);

	/**
	 * Dequeue an object from off the
	 * 
	 * @return Object dequeued
	 */
	public Object dequeue();

	/**
	 * @return Object at head of queue without removing it from queue
	 */
	public Object peekQueue();

	/**
	 * @return Object that is head of queue. Removes head from queue
	 */
	public Object removeHead();

	/**
	 * Close this queue. Once closed, the underlying queue cannot be used again
	 */
	public void close();
}