Package opennlp.tools.formats.convert

# Class NameToTokenSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<NameSample,TokenSample>
opennlp.tools.formats.convert.NameToTokenSampleStream

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

@Internal public class NameToTokenSampleStream extends FilterObjectStream<NameSample,TokenSample>
Note: Do not use this class, internal use only!

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `NameToTokenSampleStream(Detokenizer detokenizer, ObjectStream<NameSample> samples)`
  Initializes a `NameToTokenSampleStream`.

- ## Method Summary

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

  - ### NameToTokenSampleStream

    public NameToTokenSampleStream(Detokenizer detokenizer, ObjectStream<NameSample> samples)
    Initializes a `NameToTokenSampleStream`.
    Parameters:
      `detokenizer` - The `Detokenizer` to use. Must not be `null`.
      `samples` - The `samples` as input. Must not be `null`.
    Throws:
      `IllegalArgumentException` - Thrown if parameters are invalid.

- ## Method Details

  - ### read

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