BUG-865: deprecate pre-Beryllium parser elements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / api / UnknownSchemaNodeBuilder.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.parser.builder.api;
9
10 import org.opendaylight.yangtools.yang.common.QName;
11 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
12 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
13 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
14
15 /**
16  * @deprecated Pre-Beryllium implementation, scheduled for removal.
17  */
18 @Deprecated
19 public interface UnknownSchemaNodeBuilder extends SchemaNodeBuilder, DocumentedNodeBuilder {
20
21     @Override
22     SchemaPath getPath();
23
24     /**
25      * Returns true if node was added via uses statement
26      *
27      * @return true if node was added via uses statement
28      */
29     boolean isAddedByUses();
30
31     /**
32      * Sets flag if node was introduced by uses statement
33      *
34      * @param addedByUses true if node was introduced by uses, false otherwise
35      */
36     void setAddedByUses(boolean addedByUses);
37
38     /**
39      *
40      * Returns QName associated with this unknown node.
41      *
42      * @return QName associated with this unknown node.
43      */
44     QName getNodeType();
45
46     /**
47      * Returns string representation of argument associated with this unknown node.
48      *
49      * @return string representation of argument associated with this unknown node.
50      */
51     String getNodeParameter();
52
53     /**
54      * Sets string representation of argument associated with this unknown node.
55      * @param nodeParameter string representation of argument associated with this unknown node.
56      */
57     void setNodeParameter(String nodeParameter);
58
59     /**
60      * Returns extension definition, which declares this unknown node
61      * @return extension definition, which declares this unknown node
62      */
63     ExtensionDefinition getExtensionDefinition();
64
65     /**
66      * Sets extension definition, which declares this unknown node
67      * @param extensionDefinition extension definition, which declares this unknown node
68      */
69     void setExtensionDefinition(ExtensionDefinition extensionDefinition);
70
71     /**
72      * Returns builder for extension, which declares this unknown node.
73      *
74      * @return builder for extension, which declares this unknown node.
75      */
76     ExtensionBuilder getExtensionBuilder();
77
78     /**
79      * Sets extension builder, which declares this unknown node
80      *
81      * @param extension
82      *            extension builder, which declares this unknown node
83      */
84     void setExtensionBuilder(ExtensionBuilder extension);
85
86     @Override
87     UnknownSchemaNode build();
88
89     /**
90      * Sets node type associated with this unknown schema node
91      *
92      * @param qName node type associated with this unknown schema node
93      */
94     void setNodeType(QName qName);
95
96 }