components.sequence

Interface Sequence<T>

Type Parameters:

T -

All Superinterfaces:

java.lang.Iterable<T>, SequenceKernel<T>, Standard<Sequence<T>>

All Known Implementing Classes:

Sequence1L, SequenceDL, SequenceSecondary

public interface Sequence<T>
extends SequenceKernel<T>, java.lang.Iterable<T>

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

Author:

Matthew Shoemaker

Method Summary

Modifier and Type	Method and Description
void	append(Sequence<T> seq) Appends the entries in seq to the end of this.
void	append(T entry) Appends entry to the end of this.
boolean	contains(T entry) Reports whether entry is in this.
T	entry(int pos) Returns a reference to the entry at index pos of this.
T	replaceEntry(int pos, T entry) Replaces the entry at index pos of #this with entry.

Methods inherited from interface components.sequence.SequenceKernel

add, length, remove

Methods inherited from interface components.standard.Standard

clear, newInstance, transferFrom

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

append

void append(Sequence<T> seq)

Appends the entries in seq to the end of this.

Parameters:

seq - sequence whose entries will be appended to this

Updates:

this

Requires:

seq is not null

Ensures:

this = #this * seq

append

void append(T entry)

Appends entry to the end of this.

Parameters:

entry - entry to be appended to this

Updates:

this

Requires:

entry is not null

Ensures:

this = #this * entry

entry

T entry(int pos)

Returns a reference to the entry at index pos of this.

Parameters:

pos - index position

Returns:

entry at index pos of this

Requires:

pos < this.length and this.length > 0

Ensures:

entry = [entry at index pos of this]

replaceEntry

T replaceEntry(int pos,
               T entry)

Replaces the entry at index pos of #this with entry.

Parameters:

pos - index of entry in #this to be replaced

entry - entry that will take the place of the entry at index pos of #this

Returns:

the entry at index pos of #this

Requires:

pos < this.length and this.length > 0

Ensures:

 replaceEntry = [the entry at index  pos of  #this] and
 [the entry at index  pos 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]