oracle.javatools.parser.java.v2.write

Interface SourceTransaction

public interface SourceTransaction

Write operations on a SourceFile need to be performed during a transaction so resources can be kept alive during the duration of that transaction. The creation of a SourceTransaction begins the transaction, and calls to abort() or commit() of that SourceTransaction instance close the transaction. IMPORTANT: The basic pattern to use for transactions is as follows: begin transaction // Don't put code here try { code that uses transaction including rollbacks transaction commit set transaction object to null OR set success flag } finally { if transaction object != null OR !success then abort }

Method Summary

Modifier and Type	Method and Description
void	abort() Rolls back changes to the beginning of the transaction, releases all locked resources, and closes the transaction.
void	addListener(SourceTransactionListener listener) Registers the given observer to begin receiving notifications when changes are made during this transaction.
javax.swing.undo.UndoableEdit	commit() Commits the transaction changes, releases all locked resources, and closes the transaction.
SourceFile	getOwningSourceFile() Get the SourceFile this transaction is attached to.
void	removeListener(SourceTransactionListener listener) Unregisters the given observer.
void	rollback() Rolls back all changes made in this transaction and keeps the transaction open.
void	rollback(SourceSavepoint savepoint) Rolls back changes up to the given savepoint and keeps the transaction open.
SourceSavepoint	savepoint() Puts the transaction into a stable state such that it can be saved and used for future rollbacks.

Method Detail

getOwningSourceFile

SourceFile getOwningSourceFile()

Get the SourceFile this transaction is attached to.

Returns:

A SourceFile

savepoint

SourceSavepoint savepoint()

Puts the transaction into a stable state such that it can be saved and used for future rollbacks.

Returns:

A savepoint that can be used for rollbacks.

rollback

void rollback(SourceSavepoint savepoint)

Rolls back changes up to the given savepoint and keeps the transaction open.

Parameters:

savepoint - A savepoint previousely returned by the savepoint method

rollback

void rollback()

Rolls back all changes made in this transaction and keeps the transaction open.

commit

javax.swing.undo.UndoableEdit commit()

Commits the transaction changes, releases all locked resources, and closes the transaction.

Returns:

Null if this transaction involved no changes. Otherwise an UndoableEdit containing the changes.

abort

void abort()

Rolls back changes to the beginning of the transaction, releases all locked resources, and closes the transaction. This should be called when the transaction is abandoned before a commit(), or as part of the cleanup in the finally block if the transaction did not complete the commit() successfully.

addListener

void addListener(SourceTransactionListener listener)

Registers the given observer to begin receiving notifications when changes are made during this transaction.

Parameters:

listener - The listener to be added.

removeListener

void removeListener(SourceTransactionListener listener)

Unregisters the given observer.

Parameters:

listener - The listener to be removed.