OntoNotesNameSampleStream (Apache OpenNLP Tools 2.5.9 API)
Description: declaration: package: opennlp.tools.formats.ontonotes, class: OntoNotesNameSampleStream

# Class OntoNotesNameSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<String, NameSample>
opennlp.tools.formats.ontonotes.OntoNotesNameSampleStream

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

public class OntoNotesNameSampleStream extends FilterObjectStream<String, NameSample>
Name Sample Stream parser for the OntoNotes 4.0 named entity files.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `OntoNotesNameSampleStream(ObjectStream<String> samples)`
  Initializes a `OntoNotesNameSampleStream`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `NameSample`
  `read()`
  Returns the next `T` object.

  ### Methods inherited from class FilterObjectStream

  `close, reset`

  ### Methods inherited from class Object

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

- ## Constructor Details

  - ### OntoNotesNameSampleStream

    public OntoNotesNameSampleStream(ObjectStream<String> samples)
    Initializes a `OntoNotesNameSampleStream`.
    Parameters:
      `samples` - The `samples` as input. Must not be `null`.
    Throws:
      `IllegalArgumentException` - Thrown if parameters are invalid.

- ## Method Details

  - ### read

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