edu.ucla.sspace.text

Class BufferedFileListDocumentIterator

java.lang.Object

edu.ucla.sspace.text.BufferedFileListDocumentIterator

All Implemented Interfaces:

Iterator<Document>

public class BufferedFileListDocumentIterator
extends Object
implements Iterator<Document>

An iterator implementation that returns Document instances given a file that contains list of files, buffering their contents as necessary.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
BufferedFileListDocumentIterator(String fileListName) Creates an Iterator over the files listed in the provided file using the default buffer size.
BufferedFileListDocumentIterator(String fileListName, int bufferSize) Creates an Iterator over the files listed in the provided file.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if there are more documents to return.
Document	next() Returns the next document from the list.
void	remove() Throws an UnsupportedOperationException if called.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedFileListDocumentIterator

public BufferedFileListDocumentIterator(String fileListName)
                                 throws IOException

Creates an Iterator over the files listed in the provided file using the default buffer size.

Throws:

IOException - if any error occurs when reading fileListName

BufferedFileListDocumentIterator

public BufferedFileListDocumentIterator(String fileListName,
                                int bufferSize)
                                 throws IOException

Creates an Iterator over the files listed in the provided file.

Throws:

IOException - if any error occurs when reading fileListName

Method Detail

hasNext

public boolean hasNext()

Returns true if there are more documents to return.

Specified by:

hasNext in interface Iterator<Document>

next

public Document next()

Returns the next document from the list.

Specified by:

next in interface Iterator<Document>

remove

public void remove()

Throws an UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<Document>