components.queue

Interface Queue<T>

All Superinterfaces:

java.lang.Iterable<T>, QueueKernel<T>, Standard<Queue<T>>

All Known Implementing Classes:

Queue1L, QueueDL, QueueSecondary

public interface Queue<T>
extends QueueKernel<T>, java.lang.Iterable<T>

Additional functionality upon the bare-bones functionality afforded by the QueueKernel interface. All method implementations must, by design, use only the QueueKernel methods to perform operations on the component.

Author:

Matthew Shoemaker

Method Summary

Modifier and Type	Method and Description
void	append(java.util.Collection<T> collection) Appends the entries in collection to the end of this.
void	append(Queue<T> collection) Appends the entries in collection to the end of this.
boolean	contains(T entry) Reports whether entry is in this.
void	flip() Reverses the order of the entries in this.
void	sort(java.util.Comparator<T> comparator) Sorts the entries in this according to the order provided by comparator.

Methods inherited from interface components.queue.QueueKernel

dequeue, enqueue, front, length, replaceFront

Methods inherited from interface components.standard.Standard

clear, newInstance, transferFrom

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

flip

void flip()

Reverses the order of the entries in this.

Updates:

this

Ensures:

this = rev(#this)

append

void append(java.util.Collection<T> collection)

Appends the entries in collection to the end of this.

Parameters:

collection - collections whose entries will be appended to this

Updates:

this

Requires:

collection is not null

Ensures:

this = #this * collection

append

void append(Queue<T> collection)

Appends the entries in collection to the end of this.

Parameters:

collection - collections whose entries will be appended to this

Updates:

this

Requires:

collection is not null

Ensures:

this = #this * collection

sort

void sort(java.util.Comparator<T> comparator)

Sorts the entries in this according to the order provided by comparator.

Parameters:

comparator - ordering to be imposed on #this

Updates:

this

Requires:

comparator is not null

Ensures:

this = [#this.entries sorted in the order provided by comparator]

contains

boolean contains(T entry)

Reports whether entry is in this.

Parameters:

entry - entry to be looked for

Returns:

[entry is in #this]

Ensures:

contains = [entry is in this]