craterdog.core

Interface Sequential<E>

Type Parameters:

E - The type of element that makes up the sequence.

All Superinterfaces:

Iterable<E>

public interface Sequential<E>
extends Iterable<E>

This interface should be implemented by classes that define a sequence of elements that can be iterated over in a sequential manner.

Author:

Derk Norton

Method Summary

Modifier and Type	Method and Description
int	getNumberOfElements() This method returns the number of elements in the sequence.
boolean	isEmpty() This method checks to see if the sequence is empty.
Iterator<E>	iterator()
void	toArray(E[] array) This method fills the specified array with as many elements from the sequence as will fit in the array.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

isEmpty

boolean isEmpty()

This method checks to see if the sequence is empty.

Returns:

Whether or not the sequence is empty.

getNumberOfElements

int getNumberOfElements()

This method returns the number of elements in the sequence.

Returns:

The number of elements in the sequence.

toArray

void toArray(E[] array)

This method fills the specified array with as many elements from the sequence as will fit in the array. If the array is larger than the sequence, the remaining elements in the array remain unchanged.

Parameters:

array - An array to be used to hold the elements of the sequence.

iterator

Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>