Package opennlp.tools.util

Class PlainTextByLineStream

  • All Implemented Interfaces:
    java.lang.AutoCloseable, ObjectStream<java.lang.String>
    public class PlainTextByLineStream
extends java.lang.Object
implements ObjectStream<java.lang.String>
    Reads a plain text file and return each line as a String object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes the ObjectStream and releases all allocated resources.
      java.lang.String read()
      Returns the next object.
      void reset()
      Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PlainTextByLineStream

        public PlainTextByLineStream​(InputStreamFactory inputStreamFactory,
                             java.lang.String charsetName)
                      throws java.io.IOException
        Throws:
        java.io.IOException

      • PlainTextByLineStream

        public PlainTextByLineStream​(InputStreamFactory inputStreamFactory,
                             java.nio.charset.Charset charset)
                      throws java.io.IOException
        Throws:
        java.io.IOException

    • Method Detail

      • read

        public java.lang.String read()
                      throws java.io.IOException
        Description copied from interface: ObjectStream
        Returns the next object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.
        Specified by:
        read in interface ObjectStream<java.lang.String>
        Returns:
        the next object or null to signal that the stream is exhausted
        Throws:
        java.io.IOException - if there is an error during reading

      • reset

        public void reset()
           throws java.io.IOException
        Description copied from interface: ObjectStream
        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.
        Specified by:
        reset in interface ObjectStream<java.lang.String>
        Throws:
        java.io.IOException - if there is an error during reseting the stream

      • close

        public void close()
           throws java.io.IOException
        Description copied from interface: ObjectStream
        Closes the ObjectStream and releases all allocated resources. After close was called its not allowed to call read or reset.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface ObjectStream<java.lang.String>
        Throws:
        java.io.IOException - if there is an error during closing the stream