Package opennlp.tools.ml.model

# Class SequenceStreamEventStream

java.lang.Object
opennlp.tools.ml.model.SequenceStreamEventStream

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

public class SequenceStreamEventStream extends Object implements ObjectStream<Event>
Class which turns a `SequenceStream` into an event stream.

See Also:
  - `Event`
  - `ObjectStream`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SequenceStreamEventStream(SequenceStream<Event> sequenceStream)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `close()`
  Closes the `ObjectStream` and releases all allocated resources.
  `Event`
  `read()`
  Returns the next `ObjectStream` object.
  `void`
  `reset()`
  Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### SequenceStreamEventStream

    public SequenceStreamEventStream(SequenceStream<Event> sequenceStream)

- ## Method Details

  - ### read

    public Event 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.
    Specified by:
      `read` in interface `ObjectStream<Event>`
    Returns:
      The next object or `null` to signal that the stream is exhausted.
    Throws:
      `IOException` - Thrown if there is an error during reading.

  - ### reset

    public void reset() throws IOException, UnsupportedOperationException
    Description copied from interface: `ObjectStream`
    Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly. This method can be used to re-read the stream if multiple passes over the objects are required.

    The implementation of this method is optional.

    Specified by:
      `reset` in interface `ObjectStream<Event>`
    Throws:
      `IOException` - Thrown if there is an error during resetting the stream.
      `UnsupportedOperationException` - Thrown if the `reset()` is not supported. By default, this is the case.

  - ### close

    public void close() throws IOException
    Description copied from interface: `ObjectStream`
    Closes the `ObjectStream` and releases all allocated resources. After close was called, it's not allowed to call `ObjectStream.read()` or `ObjectStream.reset()`.
    Specified by:
      `close` in interface `AutoCloseable`
    Specified by:
      `close` in interface `ObjectStream<Event>`
    Throws:
      `IOException` - Thrown if there is an error during closing the stream.