de.shadowhunt.subversion

Interface Transaction

All Superinterfaces:

View

All Known Implementing Classes:

TransactionImpl

public interface Transaction
extends View

Transaction allows the application to define units of work, it can be created via Repository.createTransaction().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Transaction.Status Defines the status of each Resource that is part of the current active Transaction.

Method Summary

Modifier and Type	Method and Description
Map<Resource,Transaction.Status>	getChangeSet() Returns a Map of Resources (that are part of this Transaction and their Transaction.Status.
String	getId() Returns the identifier of the Transaction (unique for each Repository.
void	invalidate() After Repository.commit(Transaction, String, boolean) or Repository.rollback(Transaction) the Transaction is invalidated.
boolean	isActive() Determines whether the Transaction can still be used.
boolean	isChangeSetEmpty() Whether there are any Resources that are affected by the Transaction.
boolean	register(Resource resource, Transaction.Status status) Tell the Transaction the specified Resource will be affected during Repository.commit(Transaction, String, boolean).

Methods inherited from interface de.shadowhunt.subversion.View

getHeadRevision, getRepositoryId

Method Detail

getChangeSet

Map<Resource,Transaction.Status> getChangeSet()

Returns a Map of Resources (that are part of this Transaction and their Transaction.Status.

Returns:

the Map of Resources and their Transaction.Status

getId

String getId()

Returns the identifier of the Transaction (unique for each Repository.

Returns:

the identifier of the Transaction

invalidate

void invalidate()

After Repository.commit(Transaction, String, boolean) or Repository.rollback(Transaction) the Transaction is invalidated. For internal usage only. Use Repository.commit(Transaction, String, boolean) or Repository.rollback(Transaction) instead

isActive

boolean isActive()

Determines whether the Transaction can still be used. It cannot be used after Repository.commit(Transaction, String, boolean) or Repository.rollback(Transaction) where called.

Returns:

true if the Transaction can still be used otherwise false

isChangeSetEmpty

boolean isChangeSetEmpty()

Whether there are any Resources that are affected by the Transaction.

Returns:

true if there are no Resources affected by the Transaction, otherwise false

register

boolean register(Resource resource,
                 Transaction.Status status)

Tell the Transaction the specified Resource will be affected during Repository.commit(Transaction, String, boolean). For internal usage only. Use the methods from Repository instead

Parameters:

resource - Resource to register to the Transaction

status - Transaction.Status of the registered Resource

Returns:

true if the registration modified the change set, otherwise false

Throws:

NullPointerException - if any parameter is null