SentenceSampleStream (Apache OpenNLP Tools 2.5.9 API)
Description: declaration: package: opennlp.tools.sentdetect, class: SentenceSampleStream

# Class SentenceSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<String, SentenceSample>
opennlp.tools.sentdetect.SentenceSampleStream

All Implemented Interfaces:
  `AutoCloseable, ObjectStream<SentenceSample>`

public class SentenceSampleStream extends FilterObjectStream<String, SentenceSample>
This class is a stream filter which reads a sentence by line samples from an `ObjectStream` and converts them into `SentenceSample` objects. An empty line indicates the beginning of a new document.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SentenceSampleStream(ObjectStream<String> sentences)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `SentenceSample`
  `read()`
  Returns the next `T` object.
  `static String`
  `replaceNewLineEscapeTags(String s)`

  ### Methods inherited from class FilterObjectStream

  `close, reset`

  ### Methods inherited from class Object

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

- ## Constructor Details

  - ### SentenceSampleStream

    public SentenceSampleStream(ObjectStream<String> sentences)

- ## Method Details

  - ### replaceNewLineEscapeTags

    public static String replaceNewLineEscapeTags(String s)

  - ### read

    public SentenceSample read() throws IOException
    Description copied from interface: `ObjectStream`
    Returns the next `T` 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.