dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/store/DOMStore.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.mdsal.dom.spi.store;
   9
  10 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  11
  12 /**
  13  * DOM Data Store
  14  *
  15  * <p>
  16  * DOM Data Store provides transactional tree-like storage for YANG-modeled entities described by YANG schema
  17  * and represented by {@link NormalizedNode}. Read and write access to stored data is provided only via transactions
  18  * created using {@link #newReadOnlyTransaction()}, {@link #newWriteOnlyTransaction()} and
  19  * {@link #newReadWriteTransaction()}, or via {@link DOMStoreTransactionChain}.
  20  */
  21 public interface DOMStore extends DOMStoreTransactionFactory {
  22     /**
  23      * Creates new transaction chain.
  24      *
  25      * <p>
  26      * Transactions in a chain need to be committed in sequence and each
  27      * transaction should see the effects of previous transactions as if they
  28      * happened.
  29      *
  30      * <p>
  31      * See {@link DOMStoreTransactionChain} for more information.
  32      *
  33      * @return Newly created transaction chain.
  34      */
  35     DOMStoreTransactionChain createTransactionChain();
  36 }