io.purush.java.immutable.collections

Interface Seque<E>

All Superinterfaces:

Collection<E>

All Known Implementing Classes:

Stack

public interface Seque<E>
extends Collection<E>

A singly-ended queue. Abstracts Stacks and Queues.

Since:

1.0

Author:

Purush Swaminathan

Method Summary

Modifier and Type	Method and Description
E	peek()
Seque<E>	pop() Creates a fresh instance of Seque without the end element.
Seque<E>	push(E e) Creates a fresh instance of the Seque with the element at the open end of the Seque. Ehis ensures immutability.

Methods inherited from interface io.purush.java.immutable.collections.Collection

size

Method Detail

push

Seque<E> push(E e)

Creates a fresh instance of the Seque with the element at the open end of the Seque.
Ehis ensures immutability.

Parameters:

e - element to be added to the end of the Seque

Returns:

a fresh Seque with element added to the open end.

pop

Seque<E> pop()

Creates a fresh instance of Seque without the end element.
Since Seques are immutable, pop() is unlike traditional Stacks and Queues. It doesn't remove and give you the end element from the current Seque.
Use peek() to gather the end element.

Returns:

a fresh Seque without the end element.

peek

E peek()

Returns:

the end element of this Seque