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

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 and Description
DataTreeSnapshotCursor	createCursor(YangInstanceIdentifier path) Deprecated. Use openCursor(YangInstanceIdentifier) instead.
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.
default Optional<? extends DataTreeSnapshotCursor>	openCursor(YangInstanceIdentifier path) Create a new DataTreeSnapshotCursor at specified path.

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

getSchemaContext, readNode

Method Detail

createCursor

@Deprecated
 @Nullable
DataTreeSnapshotCursor createCursor(@Nonnull
                                                           YangInstanceIdentifier path)

Deprecated. Use openCursor(YangInstanceIdentifier) instead.

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 null if the path does not exist.

Throws:

IllegalStateException - if there is another cursor currently open.

openCursor

default Optional<? extends DataTreeSnapshotCursor> openCursor(@Nonnull
                                                              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