Package opennlp.tools.formats

Klasse DirectorySampleStream

java.lang.Object
opennlp.tools.formats.DirectorySampleStream
Alle implementierten Schnittstellen:
AutoCloseable, ObjectStream<File>
public class DirectorySampleStream extends Object implements ObjectStream<File>
The directory sample stream allows for creating an ObjectStream<File> from a directory listing of files.

  • Konstruktordetails

    • DirectorySampleStream

      public DirectorySampleStream(File[] dirs, FileFilter fileFilter, boolean recursive)
      Initializes a DirectorySampleStream.
      Parameter:
      dirs - The directories to read.
      fileFilter - The filter to apply while enumerating files.
      recursive - Enables or disables recursive file listing.
      Löst aus:
      IllegalArgumentException - Thrown if one element in dirs is not a directory.

    • DirectorySampleStream

      public DirectorySampleStream(File dir, FileFilter fileFilter, boolean recursive)
      Initializes a DirectorySampleStream.
      Parameter:
      dir - The directory to read.
      fileFilter - The filter to apply while enumerating files.
      recursive - Enables or disables recursive file listing.
      Löst aus:
      IllegalArgumentException - Thrown if dir is not a directory.

  • Methodendetails

    • read

      public File read() throws IOException
      Beschreibung aus Schnittstelle kopiert: ObjectStream
      Returns the next ObjectStream object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.
      Angegeben von:
      read in Schnittstelle ObjectStream<File>
      Gibt zurück:
      The next object or null to signal that the stream is exhausted.
      Löst aus:
      IOException - Thrown if there is an error during reading.

    • reset

      public void reset()
      Beschreibung aus Schnittstelle kopiert: 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.

      Angegeben von:
      reset in Schnittstelle ObjectStream<File>

    • close

      public void close() throws IOException
      Closes the ObjectStream and releases all allocated resources. After close was called, it's not allowed to call ObjectStream.read() or ObjectStream.reset(). Calling this function has no effect on the stream.
      Angegeben von:
      close in Schnittstelle AutoCloseable
      Angegeben von:
      close in Schnittstelle ObjectStream<File>
      Löst aus:
      IOException - Thrown if there is an error during closing the stream.