components.stack

Interface Stack<T>

Type Parameters:

T -

All Superinterfaces:

java.lang.Iterable<T>, StackKernel<T>, Standard<Stack<T>>

All Known Implementing Classes:

Stack1L, StackSecondary, StackSL

public interface Stack<T>
extends StackKernel<T>, java.lang.Iterable<T>

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

Author:

Matthew Shoemaker

Method Summary

Modifier and Type	Method and Description
boolean	contains(T entry) Reports whether entry is in this.
void	flip() Reverses the order of the entries in this.
T	swapTop(T entry) Replaces the entry at the top of this with entry
T	top() Returns a reference to, but does not remove, the top of this.

Methods inherited from interface components.stack.StackKernel

pop, push, size

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)

swapTop

T swapTop(T entry)

Replaces the entry at the top of this with entry

Parameters:

entry - new top of the stack

Returns:

the top of #this

Updates:

this

Requires:

entry is not null and this.length > 0

Ensures:

 swapTop = [top of  #this] and
 [top of  #this is replaced with  entry]
 

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]

top

T top()

Returns a reference to, but does not remove, the top of this.

Returns:

a reference to the top of the stack

Requires:

this.size > 0

Ensures:

top = [the top of #this]