Package opennlp.tools.parser

# Class ParseSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<String,Parse>
opennlp.tools.parser.ParseSampleStream

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

public class ParseSampleStream extends FilterObjectStream<String,Parse>

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ParseSampleStream(ObjectStream<String> in)`
  Initializes a `instance`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Parse`
  `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 Details

  - ### ParseSampleStream

    public ParseSampleStream(ObjectStream<String> in)
    Initializes a `instance`.
    Parameters:
      `in` - A plain text `stream` used as input.

- ## Method Details

  - ### read

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