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

# Class ConlluPOSSampleStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<ConlluSentence, POSSample>
opennlp.tools.formats.conllu.ConlluPOSSampleStream

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

public class ConlluPOSSampleStream extends FilterObjectStream<ConlluSentence, POSSample>

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ConlluPOSSampleStream(ObjectStream<ConlluSentence> samples, ConlluTagset tagset)`
  Initializes a `ConlluPOSSampleStream`.

- ## Method Summary

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

  - ### ConlluPOSSampleStream

    public ConlluPOSSampleStream(ObjectStream<ConlluSentence> samples, ConlluTagset tagset)
    Initializes a `ConlluPOSSampleStream`.
    Parameters:
      `samples` - The `samples` used as input.
      `tagset` - The `ConlluTagset` to use. Must not be `null`.

- ## Method Details

  - ### read

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