Package opennlp.tools.formats
Class DirectorySampleStream
java.lang.Object
opennlp.tools.formats.DirectorySampleStream
- All Implemented Interfaces:
AutoCloseable,ObjectStream<File>
The directory sample stream allows for creating an
ObjectStream<File>
from a directory listing of files.-
Constructor Summary
ConstructorsConstructorDescriptionDirectorySampleStream(File[] dirs, FileFilter fileFilter, boolean recursive) Initializes aDirectorySampleStream.DirectorySampleStream(File dir, FileFilter fileFilter, boolean recursive) Initializes aDirectorySampleStream. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes theObjectStreamand releases all allocated resources.read()Returns the nextObjectStreamobject.voidreset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
-
Constructor Details
-
DirectorySampleStream
Initializes aDirectorySampleStream.- Parameters:
dirs- Thedirectoriesto read.fileFilter- Thefilterto apply while enumerating files.recursive- Enables or disables recursive file listing.- Throws:
IllegalArgumentException- Thrown if one element indirsis not a directory.
-
DirectorySampleStream
Initializes aDirectorySampleStream.- Parameters:
dir- Thedirectoryto read.fileFilter- Thefilterto apply while enumerating files.recursive- Enables or disables recursive file listing.- Throws:
IllegalArgumentException- Thrown ifdiris not a directory.
-
-
Method Details
-
read
Description copied from interface:ObjectStreamReturns the nextObjectStreamobject. Calling this method repeatedly until it returnsnullwill return each object from the underlying source exactly once.- Specified by:
readin interfaceObjectStream<File>- Returns:
- The next object or
nullto signal that the stream is exhausted. - Throws:
IOException- Thrown if there is an error during reading.
-
reset
public void reset()Description copied from interface:ObjectStreamRepositions 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:
resetin interfaceObjectStream<File>
-
close
Closes theObjectStreamand releases all allocated resources. After close was called, it's not allowed to callObjectStream.read()orObjectStream.reset(). Calling this function has no effect on the stream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceObjectStream<File>- Throws:
IOException- Thrown if there is an error during closing the stream.
-