ucar.ma2

Interface StructureDataIterator

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ArrayStructure.ArrayStructureIterator, SequenceIterator, StructureDataIteratorLimited, StructureDataIteratorMediated

public interface StructureDataIterator
extends java.io.Closeable

An iterator over StructureData. Make sure that you call close(). Best to put in a try/finally block like:

 try {
   while (iter.hasNext())
     process(iter.next());
 } finally {
   iter.finish();
 }
 

Since:

Feb 23, 2008

Method Summary

Modifier and Type	Method and Description
default void	close() Make sure that the iterator is complete, and recover resources.
int	getCurrentRecno()
boolean	hasNext() See if theres more StructureData in the iteration.
StructureData	next() Get the next StructureData in the iteration.
StructureDataIterator	reset() Start the iteration over again.
default void	setBufferSize(int bytes) Hint to use this much memory in buffering the iteration.

Method Detail

close

default void close()

Make sure that the iterator is complete, and recover resources. Best to put in a try/finally block like:

 try (StructureDataIterator iter = obj.getStructureDataIterator()) {
   while (iter.hasNext())
     process(iter.next());
 }
 

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

getCurrentRecno

int getCurrentRecno()

hasNext

boolean hasNext()
         throws java.io.IOException

See if theres more StructureData in the iteration. You must always call this before calling next().

Returns:

true if more records are available

Throws:

java.io.IOException - on read error

next

StructureData next()
            throws java.io.IOException

Get the next StructureData in the iteration.

Returns:

next StructureData record.

Throws:

java.io.IOException - on read error

reset

StructureDataIterator reset()

Start the iteration over again.

Returns:

a new or reset iterator.

setBufferSize

default void setBufferSize(int bytes)

Hint to use this much memory in buffering the iteration. No guarentee that it will be used by the implementation.

Parameters:

bytes - amount of memory in bytes