EventTraceStream (Apache OpenNLP Tools 2.1.1 API)

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
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Event 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 Detail
  - 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 Detail
  - 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.
    
    Returns:
    
    The next object or null to signal that the stream is exhausted.
    
    Throws:
    
    IOException - Thrown if there is an error during reading.