CursorAwareDataTreeModification (yang-data-tree-api 13.0.3 API)

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

Description

default DataTreeModificationCursor

openCursor()

Create a new DataTreeModificationCursor at the root of the modification.

Optional<? extends DataTreeModificationCursor>

openCursor(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Create a new DataTreeModificationCursor at specified path.

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

Methods inherited from interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification
applyToCursor, delete, merge, ready, write

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

Method Details
- openCursor
  
  Optional<? extends DataTreeModificationCursor> openCursor(org.opendaylight.yangtools.yang.data.api.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.