opennlp.tools.util
Interface ObjectStream<T>

All Known Implementing Classes:

AbstractToSentenceSampleStream, ChunkSampleStream, ChunkSampleStream, CollectionObjectStream, Conll02NameSampleStream, ConllXPOSSampleStream, CrossValidationPartitioner.TrainingSampleStream, DocumentSampleStream, FilterObjectStream, NameFinderCensus90NameStream, NameSampleDataStream, NameToSentenceSampleStream, NameToTokenSampleStream, ParagraphStream, ParseSampleStream, PlainTextByLineStream, PosSampleStream, POSToSentenceSampleStream, POSToTokenSampleStream, SentenceSampleStream, TokenizerStream, TokenSampleStream, WhitespaceTokenStream, WordTagSampleStream

public interface ObjectStream<T>

Reads Objects from a stream.

See Also:

ObjectStreamException

Method Summary

void	close() Closes the ObjectStream and releases all allocated resources.
T	read() Returns the next object.
void	reset() Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.

Method Detail

read

T read()
       throws IOException

Returns the next object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.

Returns:

the next object or null to signal that the stream is exhausted

Throws:

IOException

reset

void reset()
           throws IOException,
                  UnsupportedOperationException

Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly. This method can be used to re-read the stream if multiple passes over the objects are required. The implementation of this method is optional.

Throws:

IOException

UnsupportedOperationException

close

void close()
           throws IOException

Closes the ObjectStream and releases all allocated resources. After close was called its not allowed to call read or reset.

Throws:

IOException