2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.tree.api;
10 import com.google.common.annotations.Beta;
11 import java.util.Optional;
12 import org.eclipse.jdt.annotation.NonNull;
13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
16 * A {@link DataTreeSnapshot} which allows creation of a {@link DataTreeSnapshotCursor}.
19 public interface CursorAwareDataTreeSnapshot extends DataTreeSnapshot {
21 * Create a new {@link DataTreeSnapshotCursor} at specified path. May fail
22 * if specified path does not exist.
24 * @param path Path at which the cursor is to be anchored
25 * @return A new cursor, or empty if the path does not exist.
26 * @throws IllegalStateException if there is another cursor currently open.
28 Optional<? extends DataTreeSnapshotCursor> openCursor(@NonNull YangInstanceIdentifier path);
31 * Create a new {@link DataTreeSnapshotCursor} at the root of the modification.
33 * @return A new cursor
34 * @throws IllegalStateException if there is another cursor currently open.
36 default DataTreeSnapshotCursor openCursor() {
37 return openCursor(YangInstanceIdentifier.of()).orElseThrow();
41 CursorAwareDataTreeModification newModification();