Package opennlp.tools.util
Class PlainTextByLineStream
java.lang.Object
opennlp.tools.util.PlainTextByLineStream
- All Implemented Interfaces:
AutoCloseable,ObjectStream<String>
Reads a plain text file and returns each line as a
String object.-
Constructor Summary
ConstructorsConstructorDescriptionPlainTextByLineStream(InputStreamFactory inputStreamFactory, String charsetName) Initializes aPlainTextByLineStream.PlainTextByLineStream(InputStreamFactory inputStreamFactory, Charset charset) Initializes aPlainTextByLineStream. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes theObjectStreamand releases all allocated resources.read()Returns the nextObjectStreamobject.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
-
Constructor Details
-
PlainTextByLineStream
public PlainTextByLineStream(InputStreamFactory inputStreamFactory, String charsetName) throws IOException Initializes aPlainTextByLineStream.- Parameters:
inputStreamFactory- TheInputStreamFactoryto use. Must not benull.charsetName- The name of theCharsetthat is used for interpreting characters.- Throws:
IOException- Thrown if IO errors occurred.
-
PlainTextByLineStream
public PlainTextByLineStream(InputStreamFactory inputStreamFactory, Charset charset) throws IOException Initializes aPlainTextByLineStream.- Parameters:
inputStreamFactory- TheInputStreamFactoryto use. Must not benull.charset- TheCharsetthat is used for interpreting characters.- Throws:
IOException- Thrown if IO errors occurred.
-
-
Method Details
-
read
Description copied from interface:ObjectStreamReturns the nextObjectStreamobject. Calling this method repeatedly until it returnsnullwill return each object from the underlying source exactly once.- Specified by:
readin interfaceObjectStream<String>- Returns:
- The next object or
nullto signal that the stream is exhausted. - Throws:
IOException- Thrown if there is an error during reading.
-
reset
Description copied from interface:ObjectStreamRepositions 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.
- Specified by:
resetin interfaceObjectStream<String>- Throws:
IOException- Thrown if there is an error during resetting the stream.
-
close
Description copied from interface:ObjectStreamCloses theObjectStreamand releases all allocated resources. After close was called, it's not allowed to callObjectStream.read()orObjectStream.reset().- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceObjectStream<String>- Throws:
IOException- Thrown if there is an error during closing the stream.
-