yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/CursorAwareDataTreeModification.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.data.api.schema.tree;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Optional;
  12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  13
  14 /**
  15  * A {@link DataTreeModification} which allows creation of a {@link DataTreeModificationCursor}.
  16  */
  17 @Beta
  18 public interface CursorAwareDataTreeModification extends DataTreeModification, CursorAwareDataTreeSnapshot {
  19     /**
  20      * Create a new {@link DataTreeModificationCursor} at specified path. May fail
  21      * if specified path does not exist. It is a programming error to use normal
  22      *
  23      * @param path Path at which the cursor is to be anchored
  24      * @return A new cursor, or null if the path does not exist.
  25      * @throws IllegalStateException if there is another cursor currently open,
  26      *                               or the modification is already {@link #ready()}.
  27      * @deprecated Use {@link #openCursor(YangInstanceIdentifier)} instead.
  28      */
  29     @Deprecated
  30     @Override
  31     DataTreeModificationCursor createCursor(YangInstanceIdentifier path);
  32
  33     /**
  34      * Create a new {@link DataTreeModificationCursor} at specified path. May fail
  35      * if specified path does not exist.
  36      *
  37      * @param path Path at which the cursor is to be anchored
  38      * @return A new cursor, or empty if the path does not exist.
  39      * @throws IllegalStateException if there is another cursor currently open,
  40      *                               or the modification is already {@link #ready()}.
  41      */
  42     @Override
  43     default Optional<? extends DataTreeModificationCursor> openCursor(final YangInstanceIdentifier path) {
  44         return Optional.ofNullable(createCursor(path));
  45     }
  46
  47     /**
  48      * Create a new {@link DataTreeModificationCursor} at the root of the modification.
  49      *
  50      * @return A new cursor
  51      * @throws IllegalStateException if there is another cursor currently open.
  52      */
  53     @Override
  54     default DataTreeModificationCursor openCursor() {
  55         return openCursor(YangInstanceIdentifier.EMPTY).get();
  56     }
  57 }