com.google.enterprise.connector.util.diffing

Class SnapshotReader

java.lang.Object

com.google.enterprise.connector.util.diffing.SnapshotReader

public class SnapshotReader
extends java.lang.Object

Reader for a SnapshotStore.

Since:

2.8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SnapshotReader.RecordReader Reads the snapshot file one record at a time.

Constructor Summary

Constructors

Constructor and Description
SnapshotReader(java.io.BufferedReader in, java.lang.String inputPath, long snapshotNumber, DocumentSnapshotFactory documentSnapshotFactory) Constructs a SnapshotReader.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying input stream.
java.lang.String	getPath()
long	getRecordNumber()
long	getSnapshotNumber()
DocumentSnapshot	read()
void	skipRecords(long number) Read and discard number records.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotReader

public SnapshotReader(java.io.BufferedReader in,
                      java.lang.String inputPath,
                      long snapshotNumber,
                      DocumentSnapshotFactory documentSnapshotFactory)
               throws SnapshotReaderException

Constructs a SnapshotReader.

Parameters:

in - input for the reader

inputPath - path to the snapshot

snapshotNumber - the number of the snapshot being read

Throws:

SnapshotReaderException

Method Detail

read

public DocumentSnapshot read()
                      throws SnapshotReaderException

Returns:

the next record in this snapshot, or null if we have reached the end of the snapshot

Throws:

SnapshotReaderException

getPath

public java.lang.String getPath()

Returns:

path to the input file, for logging purposes

getRecordNumber

public long getRecordNumber()

Returns:

the number of the most recently returned record

skipRecords

public void skipRecords(long number)
                 throws SnapshotReaderException,
                        java.lang.InterruptedException

Read and discard number records.

Parameters:

number - of records to skip.

Throws:

SnapshotReaderException - on IO errors, or if there aren't enough records.

java.lang.InterruptedException - it the calling thread is interrupted.

getSnapshotNumber

public long getSnapshotNumber()

Returns:

the number of the snapshot this reader is reading from

close

public void close()
           throws java.io.IOException

Closes the underlying input stream.

Throws:

java.io.IOException