com.revolsys.io

Interface Reader<T>

Type Parameters:

T - The type of the item to read.

All Superinterfaces:

AutoCloseable, Iterable<T>, ObjectWithProperties

All Known Subinterfaces:

RecordReader

All Known Implementing Classes:

AbstractDirectoryReader, AbstractMultipleIteratorReader, AbstractReader, DelegatingReader, FilterReader, GeometryReader, IteratorReader, JsonMapReader, ListReader, ListRecordReader, MapReaderRecordReader, MoepBinaryReader, MoepDirectoryReader, RecordDefinitionConvertRecordReader, RecordDirectoryReader, RecordIteratorReader, RecordStoreQueryReader, SaifReader, ShapefileDirectoryReader, XbaseDatasetReader, ZipRecordReader

public interface Reader<T>
extends Iterable<T>, ObjectWithProperties, AutoCloseable

The Reader interface defines methods for reading objects of type T. Objects can either by read as a List or using an Iterator or visited using a Visitor.

The simplest and most effecient way to loop through all objects in the reader is to use the following loop.

 Reader<T> reader = ...
 for (T object : reader) {
   // Do something with the object.
 }
 

Author:

Paul Austin

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the reader and all resources associated with it.
Iterator<T>	iterator() Return a new iterator for type T at the first item to read.
void	open() Open the reader so that it is ready to be read from.
List<T>	read() Read all items and return a List containing the items.
void	visit(Visitor<T> visitor) Visit each item returned from the reader until all items have been visited or the visit method returns false.

Methods inherited from interface com.revolsys.io.ObjectWithProperties

clearProperties, getProperties, getProperty, getProperty, removeProperty, setProperties, setProperty, setPropertySoft, setPropertyWeak

Method Detail

close

void close()
           throws RuntimeException

Close the reader and all resources associated with it.

Specified by:

close in interface AutoCloseable

Throws:

RuntimeException

iterator

Iterator<T> iterator()

Return a new iterator for type T at the first item to read. Subsequent calls to this method must return a new iterator. Implementors of this are responsible for cleaning up the iterator when the hasNext or next method on iterator reaches the end of the items to read.

Specified by:

iterator in interface Iterable<T>

Returns:

The iterator.

open

void open()

Open the reader so that it is ready to be read from.

read

List<T> read()

Read all items and return a List containing the items.

Returns:

The list of items.

visit

void visit(Visitor<T> visitor)

Visit each item returned from the reader until all items have been visited or the visit method returns false.

Parameters:

visitor - The visitor.