2 * Copyright (c) 2014 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.api.schema.tree;
10 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
13 * Interface representing a data tree which can be modified in an MVCC fashion.
15 public interface DataTree {
17 * Take a read-only point-in-time snapshot of the tree.
19 * @return Data tree snapshot.
21 DataTreeSnapshot takeSnapshot();
24 * Make the data tree use a new schema context. The context will be used
25 * only by subsequent operations.
27 * @param newSchemaContext new SchemaContext
28 * @throws IllegalArgumentException if the new context is incompatible
30 void setSchemaContext(SchemaContext newSchemaContext);
33 * Validate whether a particular modification can be applied to the data tree.
35 void validate(DataTreeModification modification) throws DataValidationFailedException;
38 * Prepare a modification for commit.
41 * @return candidate data tree
43 DataTreeCandidate prepare(DataTreeModification modification);
46 * Commit a data tree candidate.
48 * @param candidate data tree candidate
50 void commit(DataTreeCandidate candidate);