ChunkSampleStream (Apache OpenNLP Tools 1.9.5 API)
Date: 2026-06-18

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 and Description
    `ChunkSampleStream(ObjectStream<Parse> in)`

  - ### Method Summary

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

  - ### Method Detail

    - #### getInitialChunks

          public static Parse[] getInitialChunks(Parse p)

    - #### read

          public ChunkSample read()
                           throws 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.
      Returns:
        the next object or null to signal that the stream is exhausted
      Throws:
        `IOException` - if there is an error during reading

Copyright © 2026 The Apache Software Foundation. All rights reserved.