BUG-865: deprecate DataTreeFactor.create()
[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / tree / DataTreeFactory.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 org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
11
12 /**
13  * Factory interface for creating data trees.
14  */
15 public interface DataTreeFactory {
16     /**
17      * Create a new data tree.
18      *
19      * @return A data tree instance.
20      *
21      * @deprecated Use {@link #create(TreeType)} instead.
22      */
23     @Deprecated
24     DataTree create();
25
26     /**
27      * Create a new data tree.
28      *
29      * @return A data tree instance.
30      */
31     DataTree create(TreeType type);
32
33     /**
34      * Create a new data tree rooted at a particular node.
35      *
36      * @return A data tree instance.
37      */
38     DataTree create(TreeType treeType, YangInstanceIdentifier rootPath);
39 }