edu.ucla.sspace.text

Class FileDocument

java.lang.Object

edu.ucla.sspace.text.FileDocument

All Implemented Interfaces:

Document

public class FileDocument
extends Object
implements Document

A Document implementation backed by a File whose contents are used for the document text.

Constructor Summary

Constructors

Constructor and Description
FileDocument(String fileName) Constructs a Document based on the contents of the provide file, where the contests are read from disk.
FileDocument(String fileName, boolean cacheContents) Constructs a Document based on the contents of the provide file, optionally caching those contents in memory to allow reading the file multiple times.

Method Summary

Methods

Modifier and Type	Method and Description
BufferedReader	reader() Returns the BufferedReader for this document's text

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDocument

public FileDocument(String fileName)
             throws IOException

Constructs a Document based on the contents of the provide file, where the contests are read from disk.

Parameters:

fileName - the name of a file whose contents will be used as a document

Throws:

IOException - if any error occurred while reading fileName.

FileDocument

public FileDocument(String fileName,
            boolean cacheContents)
             throws IOException

Constructs a Document based on the contents of the provide file, optionally caching those contents in memory to allow reading the file multiple times.

Parameters:

fileName - the name of a file whose contents will be used as a document

Throws:

IOException

Method Detail

reader

public BufferedReader reader()

Returns the BufferedReader for this document's text

Specified by:

reader in interface Document