jigcell.compare.impl
Interface FileDataSource.IFileEncoder

All Known Implementing Classes:

XMLFileEncoder

Enclosing class:

FileDataSource

public static interface FileDataSource.IFileEncoder

An encoder for a FileDataSource. All instance variables of an encoder should be transient and otherwise invisible to serialization mechanisms.

Method Summary

void	finish()
boolean	getPredictedCompatibility(java.lang.Class clazz)
java.lang.Class	getPredictedContents()
void	prepareForRead() Loads any data the encoder needs from the source's options prior to reading.
void	prepareForWrite() Loads any data the encoder needs from the source's options prior to writing.
java.lang.Object	read()
void	write(java.lang.Object data)

Method Detail

finish

void finish()

See Also:

FileDataSource.finish()

getPredictedCompatibility

boolean getPredictedCompatibility(java.lang.Class clazz)

See Also:

IWriteableDataSource.getPredictedCompatibility(java.lang.Class)

getPredictedContents

java.lang.Class getPredictedContents()

See Also:

IReadableDataSource.getPredictedContents()

prepareForRead

void prepareForRead()
                    throws java.lang.Exception

Loads any data the encoder needs from the source's options prior to reading. This method may only be called while holding the write lock of OPTIONS_LOCK in the source.

Throws:

java.lang.Exception

prepareForWrite

void prepareForWrite()
                     throws java.lang.Exception

Loads any data the encoder needs from the source's options prior to writing. This method may only be called while holding the write lock of OPTIONS_LOCK in the source.

Throws:

java.lang.Exception

read

java.lang.Object read()
                      throws java.lang.Exception

Throws:

java.lang.Exception

See Also:

IReadableDataSource.read()

write

void write(java.lang.Object data)
           throws java.lang.Exception

Throws:

java.lang.Exception

See Also:

IWriteableDataSource.write(java.lang.Object)