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

Interface DataTreeModificationCursor

All Superinterfaces:
AutoCloseable, DataTreeSnapshotCursor
@Beta public interface DataTreeModificationCursor extends DataTreeSnapshotCursor
Extension to the DataTreeSnapshotCursor which allows modifying the data tree. An instance of this interface can be obtained from CursorAwareDataTreeModification and modifications made through this interface are staged in the parent modification.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child)
    Delete the specified child.
    void
    merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data)
    Merge the specified data with the currently-present data at specified path.
    void
    write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data)
    Replace the data at specified path with supplied data.

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

    close, enter, enter, enter, exit, exit, readNode

  • Method Details

    • delete

      void delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child)
      Delete the specified child.
      Parameters:
      child - Child identifier
      Throws:
      BackendFailedException - when implementation-specific errors occurs while servicing the request.

    • merge

      void merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data)
      Merge the specified data with the currently-present data at specified path.
      Parameters:
      child - Child identifier
      data - Data to be merged
      Throws:
      BackendFailedException - when implementation-specific errors occurs while servicing the request.

    • write

      void write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data)
      Replace the data at specified path with supplied data.
      Parameters:
      child - Child identifier
      data - New node data
      Throws:
      BackendFailedException - when implementation-specific errors occurs while servicing the request.