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

# Class SegmenterObjectStream<S,T>

java.lang.Object
opennlp.tools.util.FilterObjectStream<S,T>
opennlp.tools.formats.brat.SegmenterObjectStream<S,T>

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

Direct Known Subclasses:
  `BratNameSampleStream, DocumentToLineStream`

public abstract class SegmenterObjectStream<S,T> extends FilterObjectStream<S,T>

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SegmenterObjectStream(ObjectStream<S> in)`

- ## Method Summary

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

  - ### SegmenterObjectStream

    public SegmenterObjectStream(ObjectStream<S> in)

- ## Method Details

  - ### read

    public final T 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.