org.opendaylight.mdsal.binding.spi

Class ForwardingReadTransaction

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.mdsal.binding.spi.ForwardingTransaction

org.opendaylight.mdsal.binding.spi.ForwardingReadTransaction

All Implemented Interfaces:

AutoCloseable, ReadOperations, ReadTransaction, Transaction, org.opendaylight.yangtools.concepts.Identifiable<Object>

public class ForwardingReadTransaction
extends ForwardingTransaction
implements ReadTransaction

Utility ReadTransaction implementation which forwards all interface method invocation to a delegate instance.

Constructor Summary

Constructors

Constructor and Description
ForwardingReadTransaction(ReadTransaction delegate)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this transaction and releases all resources associated with it.
protected ReadTransaction	delegate()
com.google.common.util.concurrent.FluentFuture<Boolean>	exists(LogicalDatastoreType store, InstanceIdentifier<?> path) Determines if data data exists in the provided logical data store located at the provided path.
<T extends DataObject> com.google.common.util.concurrent.FluentFuture<Optional<T>>	read(LogicalDatastoreType store, InstanceIdentifier<T> path) Reads data from the provided logical data store located at the provided path.

Methods inherited from class org.opendaylight.mdsal.binding.spi.ForwardingTransaction

getIdentifier

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.concepts.Identifiable

getIdentifier

Constructor Detail

ForwardingReadTransaction

public ForwardingReadTransaction(ReadTransaction delegate)

Method Detail

delegate

protected ReadTransaction delegate()

Specified by:

delegate in class ForwardingTransaction

read

public <T extends DataObject> com.google.common.util.concurrent.FluentFuture<Optional<T>> read(LogicalDatastoreType store,
                                                                                               InstanceIdentifier<T> path)

Description copied from interface: ReadOperations

Reads data from the provided logical data store located at the provided path.

If the target is a subtree, then the whole subtree is read (and will be accessible from the returned data object).

Specified by:

read in interface ReadOperations

Parameters:

store - Logical data store from which read should occur.

path - Path which uniquely identifies subtree which client want to read

Returns:

a FluentFuture containing the result of the read. The Future blocks until the operation is complete. Once complete:

• If the data at the supplied path exists, the Future returns an Optional object containing the data.
• If the data at the supplied path does not exist, the Future returns Optional.empty().
• If the read of the data fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.

exists

public com.google.common.util.concurrent.FluentFuture<Boolean> exists(LogicalDatastoreType store,
                                                                      InstanceIdentifier<?> path)

Description copied from interface: ReadOperations

Determines if data data exists in the provided logical data store located at the provided path.

Default implementation just delegates to ReadOperations.read(LogicalDatastoreType, InstanceIdentifier). Implementations are recommended to override with a more efficient implementation.

Specified by:

exists in interface ReadOperations

Parameters:

store - Logical data store from which read should occur.

path - Path which uniquely identifies subtree which client want to read

Returns:

a FluentFuture containing the result of the check. The Future blocks until the operation is complete. Once complete:

• If the data at the supplied path exists, the Future returns Boolean.TRUE.
• If the data at the supplied path does not exist, the Future returns Boolean.FALSE.
• If the check fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.

close

public void close()

Description copied from interface: ReadTransaction

Closes this transaction and releases all resources associated with it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ReadTransaction