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 javax.annotation.Nonnull;
  13 import javax.annotation.Nullable;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  15
  16 /**
  17  * A {@link DataTreeModification} which allows creation of a {@link DataTreeModificationCursor}.
  18  */
  19 @Beta
  20 public interface CursorAwareDataTreeModification extends DataTreeModification, CursorAwareDataTreeSnapshot {
  21     /**
  22      * Create a new {@link DataTreeModificationCursor} at specified path. May fail
  23      * if specified path does not exist. It is a programming error to use normal
  24      *
  25      * @param path Path at which the cursor is to be anchored
  26      * @return A new cursor, or null if the path does not exist.
  27      * @throws IllegalStateException if there is another cursor currently open,
  28      *                               or the modification is already {@link #ready()}.
  29      * @deprecated Use {@link #openCursor(YangInstanceIdentifier)} instead.
  30      */
  31     @Deprecated
  32     @Override
  33     @Nullable DataTreeModificationCursor createCursor(@Nonnull YangInstanceIdentifier path);
  34
  35     /**
  36      * Create a new {@link DataTreeModificationCursor} at specified path. May fail
  37      * if specified path does not exist.
  38      *
  39      * @param path Path at which the cursor is to be anchored
  40      * @return A new cursor, or empty if the path does not exist.
  41      * @throws IllegalStateException if there is another cursor currently open,
  42      *                               or the modification is already {@link #ready()}.
  43      */
  44     @Override
  45     default Optional<? extends DataTreeModificationCursor> openCursor(@Nonnull final YangInstanceIdentifier path) {
  46         return Optional.ofNullable(createCursor(path));
  47     }
  48
  49     /**
  50      * Create a new {@link DataTreeModificationCursor} at the root of the modification.
  51      *
  52      * @return A new cursor
  53      * @throws IllegalStateException if there is another cursor currently open.
  54      */
  55     @Override
  56     default DataTreeModificationCursor openCursor() {
  57         return openCursor(YangInstanceIdentifier.EMPTY).get();
  58     }
  59 }