opennlp.tools.util
Class CollectionObjectStream<E>

java.lang.Object
  opennlp.tools.util.CollectionObjectStream<E>

All Implemented Interfaces:

ObjectStream<E>

public class CollectionObjectStream<E>
extends Object
implements ObjectStream<E>

Constructor Summary

CollectionObjectStream(Collection<E> collection)

Method Summary

void	close() Closes the ObjectStream and releases all allocated resources.
E	read() Returns the next 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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionObjectStream

public CollectionObjectStream(Collection<E> collection)

Method Detail

read

public E read()

Description copied from interface: ObjectStream

Returns the next 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<E>

Returns:

the next object or null to signal that the stream is exhausted

reset

public void reset()

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<E>

close

public void close()

Description copied from interface: ObjectStream

Closes the ObjectStream and releases all allocated resources. After close was called its not allowed to call read or reset.

Specified by:

close in interface ObjectStream<E>