edu.ucla.sspace.text

Class TemporalFileDocument

java.lang.Object

edu.ucla.sspace.text.TemporalFileDocument

All Implemented Interfaces:

Document, TemporalDocument

public class TemporalFileDocument
extends Object
implements TemporalDocument

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

Constructor Summary

Constructors

Constructor and Description
TemporalFileDocument(File file) Constructs a TemporalDocument using the contents of the provided file, using the lastModified time as its creation time.
TemporalFileDocument(File file, long timeStamp) Constructs a TemporalDocument using the contents of the provided file, which was created at the specified time.
TemporalFileDocument(String fileName) Constructs a TemporalDocument using the contents of the provided file, using the lastModified time as its creation time.
TemporalFileDocument(String fileName, long timeStamp) Constructs a TemporalDocument using the contents of the provided file, which was created at the specified time.

Method Summary

Methods

Modifier and Type	Method and Description
BufferedReader	reader() Returns the BufferedReader for this document's text
long	timeStamp() Returns the time at which this document was created.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporalFileDocument

public TemporalFileDocument(String fileName)
                     throws IOException

Constructs a TemporalDocument using the contents of the provided file, using the lastModified time as its creation time.

Parameters:

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

Throws:

IOException - if any error occurred while reading fileName.

TemporalFileDocument

public TemporalFileDocument(File file)
                     throws IOException

Constructs a TemporalDocument using the contents of the provided file, using the lastModified time as its creation time.

Parameters:

file - a file whose contents will be used as a document

Throws:

IOException - if any error occurred while reading fileName.

TemporalFileDocument

public TemporalFileDocument(String fileName,
                    long timeStamp)
                     throws IOException

Constructs a TemporalDocument using the contents of the provided file, which was created at the specified time.

Parameters:

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

timeStamp - the time at which this file was created

Throws:

IOException - if any error occurred while reading fileName.

TemporalFileDocument

public TemporalFileDocument(File file,
                    long timeStamp)
                     throws IOException

Constructs a TemporalDocument using the contents of the provided file, which was created at the specified time.

Parameters:

file - a file whose contents will be used as a document

timeStamp - the time at which this file was created

Throws:

IOException - if any error occurred while reading fileName.

Method Detail

reader

public BufferedReader reader()

Returns the BufferedReader for this document's text

Specified by:

reader in interface Document

timeStamp

public long timeStamp()

Returns the time at which this document was created.

Specified by:

timeStamp in interface TemporalDocument