com.timeindexing.plugin
Interface ReaderPlugin

All Known Implementing Classes:
Block, DefaultReader, FileItem, Line

public interface ReaderPlugin

An interface for reader plugins.


Method Summary
 java.io.InputStream getInputStream()
          Get the InputStream for the InputPlugin.
 boolean isEOF()
          Determine if the reader has hit EOF.
 ReaderResult read()
          Read some data and return it as a ReaderResult.
 ReaderPlugin setEOF()
          The reader has hit EOF.
 ReaderPlugin setInputStream(java.io.InputStream in)
          Set the InputStream for the InputPlugin.
 

Method Detail

getInputStream

public java.io.InputStream getInputStream()
Get the InputStream for the InputPlugin.


setInputStream

public ReaderPlugin setInputStream(java.io.InputStream in)
Set the InputStream for the InputPlugin.


read

public ReaderResult read()
                  throws java.io.IOException
Read some data and return it as a ReaderResult.

Throws:
java.io.IOException

isEOF

public boolean isEOF()
Determine if the reader has hit EOF.


setEOF

public ReaderPlugin setEOF()
The reader has hit EOF.