EventTraceStream (Apache OpenNLP Tools 2.5.9 API)
Description: declaration: package: opennlp.tools.util, class: EventTraceStream

# Class EventTraceStream

java.lang.Object
opennlp.tools.util.FilterObjectStream<Event,Event>
opennlp.tools.util.EventTraceStream

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

public class EventTraceStream extends FilterObjectStream<Event,Event>

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `EventTraceStream(ObjectStream<Event> stream, Writer writer)`
  Initializes an `EventTraceStream`.

- ## Method Summary

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

  - ### EventTraceStream

    public EventTraceStream(ObjectStream<Event> stream, Writer writer)
    Initializes an `EventTraceStream`.
    Parameters:
      `stream` - The `stream` of events.
      `writer` - A `Writer` used write `events` to.

- ## Method Details

  - ### read

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