Package org.opendaylight.controller.md.sal.dom.spi

Class ForwardingDOMDataReadOnlyTransaction

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.controller.md.sal.dom.spi.ForwardingDOMDataReadOnlyTransaction

All Implemented Interfaces:

AutoCloseable, AsyncReadOnlyTransaction<YangInstanceIdentifier,NormalizedNode<?,?>>, AsyncReadTransaction<YangInstanceIdentifier,NormalizedNode<?,?>>, AsyncTransaction<YangInstanceIdentifier,NormalizedNode<?,?>>, DOMDataReadOnlyTransaction, DOMDataReadTransaction, Identifiable<Object>

@Deprecated(forRemoval=true)
public abstract class ForwardingDOMDataReadOnlyTransaction
extends ForwardingObject
implements DOMDataReadOnlyTransaction

Deprecated, for removal: This API element is subject to removal in a future version.

Use ForwardingDOMDataReadOnlyTransaction instead.

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

Constructor Summary

Constructors

Constructor	Description
ForwardingDOMDataReadOnlyTransaction()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	close()	Deprecated, for removal: This API element is subject to removal in a future version. Closes this transaction and releases all resources associated with it.
protected abstract @NonNull DOMDataReadOnlyTransaction	delegate()	Deprecated, for removal: This API element is subject to removal in a future version.
CheckedFuture<Boolean,ReadFailedException>	exists(LogicalDatastoreType store, YangInstanceIdentifier path)	Deprecated, for removal: This API element is subject to removal in a future version. Checks if data is available in the logical data store located at provided path.
Object	getIdentifier()	Deprecated, for removal: This API element is subject to removal in a future version.
CheckedFuture<Optional<NormalizedNode<?,?>>,ReadFailedException>	read(LogicalDatastoreType store, YangInstanceIdentifier path)	Deprecated, for removal: This API element is subject to removal in a future version. Reads data from provided logical data store located at the provided path.

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

Constructor Detail

ForwardingDOMDataReadOnlyTransaction

public ForwardingDOMDataReadOnlyTransaction()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

delegate

protected abstract @NonNull DOMDataReadOnlyTransaction delegate()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

delegate in class ForwardingObject

read

public CheckedFuture<Optional<NormalizedNode<?,?>>,ReadFailedException> read(LogicalDatastoreType store,
                                                                                         YangInstanceIdentifier path)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DOMDataReadTransaction

Reads data from 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 DOMDataReadTransaction

Parameters:

store - Logical data store from which read should occur.

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

Returns:

a CheckFuture containing the result of the read. The Future blocks until the commit 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#absent().
• If the read of the data fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.

exists

public CheckedFuture<Boolean,ReadFailedException> exists(LogicalDatastoreType store,
                                                               YangInstanceIdentifier path)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DOMDataReadTransaction

Checks if data is available in the logical data store located at provided path.

Note: a successful result from this method makes no guarantee that a subsequent call to DOMDataReadTransaction.read(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier) will succeed. It is possible that the data resides in a data store on a remote node and, if that node goes down or a network failure occurs, a subsequent read would fail. Another scenario is if the data is deleted in between the calls to exists and read

Specified by:

exists in interface DOMDataReadTransaction

Parameters:

store - Logical data store from which read should occur.

path - Path which uniquely identifies subtree which client want to check existence of

Returns:

a CheckFuture containing the result of the check.

• If the data at the supplied path exists, the Future returns a Boolean whose value is true, false otherwise
• If checking for the data fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.

getIdentifier

public Object getIdentifier()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getIdentifier in interface AsyncTransaction<YangInstanceIdentifier,NormalizedNode<?,?>>

Specified by:

getIdentifier in interface Identifiable<Object>

close

public void close()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AsyncReadOnlyTransaction

Closes this transaction and releases all resources associated with it.

Specified by:

close in interface AsyncReadOnlyTransaction<YangInstanceIdentifier,NormalizedNode<?,?>>

Specified by:

close in interface AutoCloseable