myUtil

Interface Queue<T>

Type Parameters:

T - any user defined type

All Known Implementing Classes:

AQueue, LQueue

public interface Queue<T>

This generic interface is the standard Queue API

Author:

Chung-Chih Li

Method Summary

Modifier and Type	Method and Description
int	capacity()
T	element() Peek at the first item at the front end.
boolean	empty()
boolean	offer(T item) Offer the item into this Queue at the rear end.
T	peek() Peek at the first item at the front end.
T	poll() Remove the item at the front end.
T	remove() Remove the item from the Queue at the front end.
int	size()

Method Detail

offer

boolean offer(T item)

Offer the item into this Queue at the rear end.

Parameters:

item - of the same type

Returns:

false if fail to do so, in case the capacity is restricted.

remove

T remove()
  throws java.util.NoSuchElementException

Remove the item from the Queue at the front end.

Returns:

the item that is removed.

Throws:

java.util.NoSuchElementException - if no item to be removed.

poll

T poll()

Remove the item at the front end. This is same as Remove but no exception will be thrown.

Returns:

the item that is removed, or null if no item to be removed.

peek

T peek()

Peek at the first item at the front end.

Returns:

the first item at the front end, or null if this Queue is empty.

element

T element()
   throws java.util.NoSuchElementException

Peek at the first item at the front end.

Returns:

the first item at the front end.

Throws:

java.util.NoSuchElementException - if this Queue is empty.

empty

boolean empty()

Returns:

true if this Queue is empty, false otherwise

size

int size()

Returns:

the number of the element in the queue.

capacity

int capacity()

Returns:

the capacity of the queue, -1 if unlimited.