uk.ac.starlink.util

Interface Sequence

All Known Subinterfaces:

RowSequence, RowSplittable

All Known Implementing Classes:

AccessRowSequence, CountCheckRowSequence, EmptyRowSequence, IteratorRowSequence, MappingRowSplittable, OnceRowPipe, ProgressRowSplittable, RandomRowSplittable, ReaderRowSequence, SequentialRowSplittable, WrapperRowSequence

public interface Sequence

Utility sub-interface of Splittable suitable for use with splittable data that can be iterated over.

The main purpose of this interface is to act as standard documentation for a next method where it is provided.

Since:

13 Sep 2019

Method Summary

Modifier and Type	Method and Description
boolean	next() Move to the next item in the sequence.

Method Detail

next

boolean next()
      throws java.lang.Exception

Move to the next item in the sequence. Must be called before accessing each item, including the first one. Returns false when there are no items left.

This method is declared to throw an untyped exception. Subinterfaces are encouraged to override this method restricting the exception type or throwing no exception.

Returns:

true iff the current sequence element has data

Throws:

java.lang.Exception - if there is some failure