org.opendaylight.mdsal.dom.api

Interface DOMDataTreeReadCursor

All Superinterfaces:

AutoCloseable, DOMDataTreeCursor

public interface DOMDataTreeReadCursor
extends DOMDataTreeCursor

Method Summary

Modifier and Type	Method and Description
@NonNull FluentFuture<Boolean>	exists(@NonNull YangInstanceIdentifier.PathArgument child) Checks if data is available in the logical data store located at provided path.
@NonNull FluentFuture<Optional<NormalizedNode<?,?>>>	readNode(@NonNull YangInstanceIdentifier.PathArgument child) Read a particular node from the snapshot.

Methods inherited from interface org.opendaylight.mdsal.dom.api.DOMDataTreeCursor

close, enter, enter, enter, exit, exit

Method Detail

readNode

@NonNull FluentFuture<Optional<NormalizedNode<?,?>>> readNode(@NonNull YangInstanceIdentifier.PathArgument child)

Read a particular node from the snapshot.

Parameters:

child - Child identifier

Returns:

a FluentFuture containing the result of the read. 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.

Throws:

IllegalArgumentException - when specified path does not identify a valid child.

exists

@NonNull FluentFuture<Boolean> exists(@NonNull YangInstanceIdentifier.PathArgument child)

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 #readNode(PathArgument) 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 readNode

Parameters:

child - Child identifier

Returns:

a FluentFuture containing the result of the read. Once complete:

• 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.