BUG-865: deprecate pre-Beryllium parser elements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / util / AbstractBuilder.java
1 /*
2  * Copyright (c) 2013 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.util;
9
10 import com.google.common.base.Preconditions;
11 import java.util.ArrayList;
12 import java.util.List;
13 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
14 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
15 import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
16
17 /**
18  * Base helper implementation of Builders for Yang Model elements.
19  *
20  * @deprecated Pre-Beryllium implementation, scheduled for removal.
21  */
22 @Deprecated
23 public abstract class AbstractBuilder implements Builder {
24     private final String moduleName;
25     private final int line;
26     private Builder parentBuilder;
27
28     protected final List<UnknownSchemaNode> unknownNodes = new ArrayList<>();
29     protected final List<UnknownSchemaNodeBuilder> addedUnknownNodes = new ArrayList<>();
30     private boolean sealed;
31
32     protected AbstractBuilder(final String moduleName, final int line) {
33         this.moduleName = Preconditions.checkNotNull(moduleName,"moduleName must not be null");
34         this.line = line;
35     }
36
37     @Override
38     public String getModuleName() {
39         return moduleName;
40     }
41
42     @Override
43     public int getLine() {
44         return line;
45     }
46
47     @Override
48     public Builder getParent() {
49         return parentBuilder;
50     }
51
52     @Override
53     public void setParent(final Builder parentBuilder) {
54         checkNotSealed();
55         this.parentBuilder = parentBuilder;
56     }
57
58     @Override
59     public List<UnknownSchemaNodeBuilder> getUnknownNodes() {
60         return addedUnknownNodes;
61     }
62
63     @Override
64     public void addUnknownNodeBuilder(final UnknownSchemaNodeBuilder unknownNode) {
65         addedUnknownNodes.add(unknownNode);
66     }
67
68     void seal() {
69         checkNotSealed();
70         sealed  = true;
71     }
72
73     protected final void checkNotSealed() {
74         Preconditions.checkState(!sealed, "Builder is sealed. No further modifications allowed");
75     }
76
77     boolean isSealed() {
78         return sealed;
79     }
80
81 }