ucar.ma2
Interface StructureDataIterator

All Known Implementing Classes:
ArrayStructure.ArrayStructureIterator, SequenceIterator, StructureDataIteratorIndexed, StructureDataIteratorLimited, StructureDataIteratorLinked

public interface StructureDataIterator

An iterator over StructureData.

Since:
Feb 23, 2008
Author:
caron

Method Summary
 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.
 void setBufferSize(int bytes)
          Hint to use this much memory in buffering the iteration.
 

Method Detail

hasNext

boolean hasNext()
                throws 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:
IOException - on read error

next

StructureData next()
                   throws IOException
Get the next StructureData in the iteration.

Returns:
next StructureData record.
Throws:
IOException - on read error

setBufferSize

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

reset

StructureDataIterator reset()
Start the iteration over again.

Returns:
a new or reset iterator.

getCurrentRecno

int getCurrentRecno()


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.