com.google.enterprise.connector.util.diffing

Class SnapshotWriter

java.lang.Object

com.google.enterprise.connector.util.diffing.SnapshotWriter

public class SnapshotWriter
extends java.lang.Object

Write snapshot records in CSV format.

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
SnapshotWriter(java.io.Writer output, java.io.FileDescriptor fileDescriptor, java.lang.String path) Creates a SnapshotWriter that appends to output.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying output stream.
java.io.FileDescriptor	getFileDescriptor()
java.io.Writer	getOutput()
java.lang.String	getPath()
long	getRecordCount()
void	write(DocumentSnapshot snapshot) Appends a record to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotWriter

public SnapshotWriter(java.io.Writer output,
                      java.io.FileDescriptor fileDescriptor,
                      java.lang.String path)
               throws SnapshotWriterException

Creates a SnapshotWriter that appends to output.

Parameters:

output - CSV writer that is being wrapped

fileDescriptor - if non-{code null}, this will be flushed after each record is written to disk

path - name of output, for logging purposes

Throws:

SnapshotWriterException - on any error

Method Detail

write

public void write(DocumentSnapshot snapshot)
           throws SnapshotWriterException,
                  java.lang.IllegalArgumentException

Appends a record to the output stream.

Parameters:

snapshot - record to write

Throws:

SnapshotWriterException

java.lang.IllegalArgumentException

close

public void close()
           throws SnapshotWriterException

Closes the underlying output stream.

Throws:

SnapshotWriterException

getPath

public java.lang.String getPath()

Returns:

a path to the file this writer writes to

getRecordCount

public long getRecordCount()

Returns:

the number of records successfully written.

getOutput

public java.io.Writer getOutput()

getFileDescriptor

public java.io.FileDescriptor getFileDescriptor()