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

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o.  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 org.eclipse.jdt.annotation.NonNullByDefault;
  12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  13
  14 /**
  15  * A read-only view of a {@link DataTree}. This provides access to MVCC access methods, but unlike {@link DataTree},
  16  * it does not expose methods to affect internal state.
  17  *
  18  * @author Robert Varga
  19  */
  20 @Beta
  21 @NonNullByDefault
  22 public interface ReadOnlyDataTree {
  23     /**
  24      * Get the root path of this data tree.
  25      *
  26      * @return The tree's root path.
  27      */
  28     YangInstanceIdentifier getRootPath();
  29
  30     /**
  31      * Take a read-only point-in-time snapshot of the tree.
  32      *
  33      * @return Data tree snapshot.
  34      */
  35     DataTreeSnapshot takeSnapshot();
  36 }