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

Interface CursorAwareDataTreeModification

All Superinterfaces:

CursorAwareDataTreeSnapshot, DataTreeModification, DataTreeSnapshot

@Beta
public interface CursorAwareDataTreeModification
extends DataTreeModification, CursorAwareDataTreeSnapshot

A DataTreeModification which allows creation of a DataTreeModificationCursor.

Method Summary

Modifier and Type	Method and Description
DataTreeModificationCursor	createCursor(YangInstanceIdentifier path) Deprecated. Use openCursor(YangInstanceIdentifier) instead.
default DataTreeModificationCursor	openCursor() Create a new DataTreeModificationCursor at the root of the modification.
default Optional<? extends DataTreeModificationCursor>	openCursor(YangInstanceIdentifier path) Create a new DataTreeModificationCursor at specified path.

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

applyToCursor, delete, merge, ready, write

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

newModification

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

getSchemaContext, readNode

Method Detail

createCursor

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

Deprecated. Use openCursor(YangInstanceIdentifier) instead.

Create a new DataTreeModificationCursor at specified path. May fail if specified path does not exist. It is a programming error to use normal

Specified by:

createCursor in interface CursorAwareDataTreeSnapshot

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, or the modification is already DataTreeModification.ready().

openCursor

default Optional<? extends DataTreeModificationCursor> openCursor(@Nonnull
                                                                  YangInstanceIdentifier path)

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

Specified by:

openCursor in interface CursorAwareDataTreeSnapshot

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, or the modification is already DataTreeModification.ready().

openCursor

default DataTreeModificationCursor openCursor()

Create a new DataTreeModificationCursor at the root of the modification.

Specified by:

openCursor in interface CursorAwareDataTreeSnapshot

Returns:

A new cursor

Throws:

IllegalStateException - if there is another cursor currently open.