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

   1 /*
   2  * Copyright (c) 2014 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.base.Optional;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  12 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  13
  14 /**
  15  * Read-only snapshot of a {@link DataTree}. The snapshot is stable and isolated,
  16  * e.g. data tree changes occurring after the snapshot has been taken are not
  17  * visible through the snapshot.
  18  */
  19 public interface DataTreeSnapshot {
  20     /**
  21      * Read a particular node from the snapshot.
  22      *
  23      * @param path Path of the node
  24      * @return Optional result encapsulating the presence and value of the node
  25      */
  26     Optional<NormalizedNode<?, ?>> readNode(YangInstanceIdentifier path);
  27
  28     /**
  29      * Create a new data tree modification based on this snapshot, using the
  30      * specified data application strategy.
  31      *
  32      * @return A new data tree modification
  33      */
  34     DataTreeModification newModification();
  35 }