yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/CursorAwareDataTreeSnapshot.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 DataTreeSnapshot} which allows creation of a {@link DataTreeSnapshotCursor}.
  18  */
  19 @Beta
  20 public interface CursorAwareDataTreeSnapshot extends DataTreeSnapshot {
  21     /**
  22      * Create a new {@link DataTreeSnapshotCursor} at specified path. May fail
  23      * if specified path does not exist.
  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      * @deprecated Use {@link #openCursor(YangInstanceIdentifier)} instead.
  29      */
  30     @Deprecated
  31     @Nullable DataTreeSnapshotCursor createCursor(@Nonnull YangInstanceIdentifier path);
  32
  33     /**
  34      * Create a new {@link DataTreeSnapshotCursor} 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      */
  41     default Optional<? extends DataTreeSnapshotCursor> openCursor(@Nonnull final YangInstanceIdentifier path) {
  42         return Optional.ofNullable(createCursor(path));
  43     }
  44
  45     /**
  46      * Create a new {@link DataTreeSnapshotCursor} at the root of the modification.
  47      *
  48      * @return A new cursor
  49      * @throws IllegalStateException if there is another cursor currently open.
  50      */
  51     default DataTreeSnapshotCursor openCursor() {
  52         return openCursor(YangInstanceIdentifier.EMPTY).get();
  53     }
  54
  55     @Override
  56     CursorAwareDataTreeModification newModification();
  57 }