Package org.moeaframework.analysis.store

Class TransactionalWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

org.moeaframework.analysis.store.TransactionalWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public abstract class TransactionalWriter
extends FilterWriter

Writer with a transaction mechanism requiring one to call commit() before the content is stored. The typical use is:

   try (TransactionalWriter writer = blob.openWriter()) {
       writer.write(...);
       writer.commit();
   }
 

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
TransactionalWriter(Writer out)	Constructs a transactional writer.

Method Summary

Modifier and Type	Method	Description
void	close()
void	commit()	Indicates the content was successfully written.
protected abstract void	doCommit()	Called during close() to commit or complete the transaction.
protected abstract void	doRollback()	Called during close() to rollback the transaction.

Methods inherited from class java.io.FilterWriter

flush, write, write, write

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

TransactionalWriter

public TransactionalWriter(Writer out)

Constructs a transactional writer.

Parameters:

out - the temporary writer, where content is written before it is committed

Method Details

commit

public void commit()
            throws IOException

Indicates the content was successfully written. This method must be called before close() to take effect.

Throws:

IOException - if an I/O error occurred

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterWriter

Throws:

IOException

doCommit

protected abstract void doCommit()
                          throws IOException

Called during close() to commit or complete the transaction.

Throws:

IOException - if an I/O error occurred

doRollback

protected abstract void doRollback()
                            throws IOException

Called during close() to rollback the transaction.

Throws:

IOException - if an I/O error occurred