Deprecate all MD-SAL APIs
[controller.git] / opendaylight / md-sal / sal-dom-spi / src / main / java / org / opendaylight / controller / sal / core / spi / data / 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.controller.sal.core.spi.data;
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
17  * entities described by YANG schema and represented by {@link NormalizedNode}.
18  *
19  * <p>
20  * Read and write access to stored data is provided only via transactions
21  * created using {@link #newReadOnlyTransaction()},
22  * {@link #newWriteOnlyTransaction()} and {@link #newReadWriteTransaction()}, or
23  * by creating {@link org.opendaylight.controller.md.sal.common.api.data.TransactionChain}.
24  *
25  * @deprecated Use {@link org.opendaylight.mdsal.dom.spi.store.DOMStore} instead.
26  */
27 @Deprecated
28 public interface DOMStore extends DOMStoreTransactionFactory {
29     /**
30      * Creates new transaction chain.
31      *
32      * <p>
33      * Transactions in a chain need to be committed in sequence and each
34      * transaction should see the effects of previous transactions as if they
35      * happened.
36      *
37      * @see DOMStoreTransactionChain for more information.
38      * @return Newly created transaction chain.
39      */
40     DOMStoreTransactionChain createTransactionChain();
41 }