RecordSetIterator (GEDCOM X - Model 3.21.0 API)

All Superinterfaces:

Iterator<Gedcomx>

All Known Implementing Classes:

JsonRecordSetIterator, XmlRecordSetIterator
```
public interface RecordSetIterator
extends Iterator<Gedcomx>
```
Class for iterating through the 'record' elements (GedcomX documents) in a RecordSet one at a time from a stream (e.g., a gzipped byte array) without having to inflate all the records at once. User: Brent Hale Date: 6/9/2015

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close()`	Close the input stream and/or accompanying reader if they are still open.
`Gedcomx`	`getMetadata()`	Retrieve the metadata for the RecordSet.
`boolean`	`hasNext()`	Tell whether the RecordIterator has another GedcomX record to return.
`Gedcomx`	`next()`	Get the next Gedcomx Record from the RecordSet.
`void`	`remove()`

Methods inherited from interface java.util.Iterator
forEachRemaining

- Method Detail
  - hasNext
```
boolean hasNext()
```
    Tell whether the RecordIterator has another GedcomX record to return.
    
    Specified by:
    
    hasNext in interface Iterator<Gedcomx>
    
    Returns:
    
    true if there is another record to read; false otherwise.
  - next
```
Gedcomx next()
```
    Get the next Gedcomx Record from the RecordSet.
    
    Specified by:
    
    next in interface Iterator<Gedcomx>
    
    Returns:
    
    the next Gedcomx Record from the RecordSet.
  - getMetadata
```
Gedcomx getMetadata()
```
    Retrieve the metadata for the RecordSet.
    
    Returns:
    
    A Gedcomx document representing the metadata (or collection information) of the RecordSet.
  - remove
```
void remove()
```
    Specified by:
    
    remove in interface Iterator<Gedcomx>
  - close
```
void close()
```
    Close the input stream and/or accompanying reader if they are still open.