Module org.opendaylight.yangtools.yang.data.tree.api

Package org.opendaylight.yangtools.yang.data.tree.api

Interface CursorAwareDataTreeSnapshot

All Superinterfaces:

DataTreeSnapshot

All Known Subinterfaces:

CursorAwareDataTreeModification

@Beta
public interface CursorAwareDataTreeSnapshot
extends DataTreeSnapshot

A DataTreeSnapshot which allows creation of a DataTreeSnapshotCursor.

Method Summary

Modifier and Type	Method	Description
CursorAwareDataTreeModification	newModification()	Create a new data tree modification based on this snapshot, using the specified data application strategy.
default DataTreeSnapshotCursor	openCursor()	Create a new DataTreeSnapshotCursor at the root of the modification.
Optional<? extends DataTreeSnapshotCursor>	openCursor(@NonNull org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)	Create a new DataTreeSnapshotCursor at specified path.

Methods inherited from interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot

modelContext, readNode

Method Details

openCursor

Optional<? extends DataTreeSnapshotCursor> openCursor(@NonNull org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Create a new DataTreeSnapshotCursor at specified path. May fail if specified path does not exist.

Parameters:

path - Path at which the cursor is to be anchored

Returns:

A new cursor, or empty if the path does not exist.

Throws:

IllegalStateException - if there is another cursor currently open.

openCursor

default DataTreeSnapshotCursor openCursor()

Create a new DataTreeSnapshotCursor at the root of the modification.

Returns:

A new cursor

Throws:

IllegalStateException - if there is another cursor currently open.

newModification

CursorAwareDataTreeModification newModification()

Description copied from interface: DataTreeSnapshot

Create a new data tree modification based on this snapshot, using the specified data application strategy.

Specified by:

newModification in interface DataTreeSnapshot

Returns:

A new data tree modification