Package opennlp.tools.parser

## Class ChunkSampleStream

- java.lang.Object
- - opennlp.tools.util.FilterObjectStream<Parse,​ChunkSample>
  - - opennlp.tools.parser.ChunkSampleStream

- All Implemented Interfaces:
    `AutoCloseable`, `ObjectStream<ChunkSample>`

      public class ChunkSampleStream
      extends FilterObjectStream<Parse,​ChunkSample>

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `ChunkSampleStream​(ObjectStream<Parse> in)` | Initializes a `instance`.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Parse[]` | `getInitialChunks​(Parse p)` |
    `ChunkSample` | `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

    - #### ChunkSampleStream

          public ChunkSampleStream​(ObjectStream<Parse> in)

      Initializes a `instance`.
      Parameters:
        `in` - A `stream` used as input.

  - ### Method Detail

    - #### getInitialChunks

          public static Parse[] getInitialChunks​(Parse p)

    - #### read

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