/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.md.sal.dom.store.impl.tree;

import org.opendaylight.yangtools.yang.model.api.SchemaContext;

/**
 * Interface representing a data tree which can be modified in an MVCC fashion.
 */
public interface DataTree {
	/**
	 * Take a read-only point-in-time snapshot of the tree.
	 *
	 * @return Data tree snapshot.
	 */
	DataTreeSnapshot takeSnapshot();

	/**
	 * Make the data tree use a new schema context. The context will be used
	 * only by subsequent operations.
	 *
	 * @param newSchemaContext new SchemaContext
	 * @throws IllegalArgumentException if the new context is incompatible
	 */
    void setSchemaContext(SchemaContext newSchemaContext);

    /**
     * Validate whether a particular modification can be applied to the data tree.
     */
    void validate(DataTreeModification modification) throws DataPreconditionFailedException;

    /**
     * Prepare a modification for commit.
     *
     * @param modification
     * @return candidate data tree
     */
    DataTreeCandidate prepare(DataTreeModification modification);

    /**
     * Commit a data tree candidate.
     *
     * @param candidate data tree candidate
     */
    void commit(DataTreeCandidate candidate);
}