org.opendaylight.mdsal.dom.spi.store

Interface DOMStoreTransactionFactory

All Known Subinterfaces:

DOMStore, DOMStoreTransactionChain

All Known Implementing Classes:

AbstractSnapshotBackedTransactionChain, InMemoryDOMDataStore

public interface DOMStoreTransactionFactory

Factory for DOM Store Transactions.

Factory provides method to construct read-only, read-write and write-only transactions, which may be used to retrieve and modify stored information in Underlying DOMStore or DOMStoreTransactionChain.

See DOMStore or DOMStoreTransactionChain for concrete variations of this factory.

Note: This interface is used only to define common functionality between DOMStore and DOMStoreTransactionChain, which further specify behaviour of returned transactions.

Method Summary

Modifier and Type	Method and Description
DOMStoreReadTransaction	newReadOnlyTransaction() Creates a read only transaction.
DOMStoreReadWriteTransaction	newReadWriteTransaction() Creates Read-Write transaction.
DOMStoreWriteTransaction	newWriteOnlyTransaction() Creates write only transaction.

Method Detail

newReadOnlyTransaction

DOMStoreReadTransaction newReadOnlyTransaction()

Creates a read only transaction.

Creates a new read-only transaction, which provides read access to snapshot of current state.

See DOMStoreReadTransaction for more information.

Returns:

new DOMStoreReadTransaction

Throws:

IllegalStateException - If state of factory prevents allocating new transaction.

newWriteOnlyTransaction

DOMStoreWriteTransaction newWriteOnlyTransaction()

Creates write only transaction.

See DOMStoreWriteTransaction for more information.

Returns:

new DOMStoreWriteTransaction

Throws:

IllegalStateException - If state of factory prevents allocating new transaction.

newReadWriteTransaction

DOMStoreReadWriteTransaction newReadWriteTransaction()

Creates Read-Write transaction.

See DOMStoreReadWriteTransaction for more information.

Returns:

new DOMStoreWriteTransaction

Throws:

IllegalStateException - If state of factory prevents allocating new transaction.