Package opennlp.tools.formats.convert

Class FileToStringSampleStream

java.lang.Object

opennlp.tools.util.FilterObjectStream<File,String>

opennlp.tools.formats.convert.FileToStringSampleStream

All Implemented Interfaces:

AutoCloseable, ObjectStream<String>

public class FileToStringSampleStream
extends FilterObjectStream<File,String>

Provides the ability to read the contents of files contained in an object stream of files.

Constructor Summary

Constructors

Constructor	Description
FileToStringSampleStream(ObjectStream<File> samples, Charset encoding)	Initializes a FileToStringSampleStream.

Method Summary

Modifier and Type	Method	Description
String	read()	Returns the next ObjectStream object.

Methods inherited from class opennlp.tools.util.FilterObjectStream

close, reset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileToStringSampleStream

public FileToStringSampleStream(ObjectStream<File> samples,
                                Charset encoding)

Initializes a FileToStringSampleStream.

Parameters:

samples - The ObjectStream containing the files.

encoding - The Charset encoding of the files.

Method Detail

read

public String read()
            throws IOException

Description copied from interface: ObjectStream

Returns the next ObjectStream 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 - Thrown if there is an error during reading.