Package opennlp.tools.sentdetect

## 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

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `SentenceSample` | `read()` | Returns the next `ObjectStream` object.
    `static String` | `replaceNewLineEscapeTags​(String s)` |

    - ### 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

    - #### SentenceSampleStream

          public SentenceSampleStream​(ObjectStream<String> sentences)

  - ### Method Detail

    - #### replaceNewLineEscapeTags

          public static String replaceNewLineEscapeTags​(String s)

    - #### read

          public SentenceSample 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.