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 javax.annotation.Nonnull;
  12 import javax.annotation.Nullable;
  13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  14
  15 /**
  16  * A {@link DataTreeModification} which allows creation of a {@link DataTreeModificationCursor}.
  17  */
  18 @Beta
  19 public interface CursorAwareDataTreeModification extends DataTreeModification, CursorAwareDataTreeSnapshot {
  20     /**
  21      * Create a new {@link DataTreeModificationCursor} at specified path. May fail
  22      * if specified path does not exist. It is a programming error to use normal
  23      *
  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      */
  30     @Override
  31     @Nullable DataTreeModificationCursor createCursor(@Nonnull YangInstanceIdentifier path);
  32 }