BUG 1131: Introduced sealing of builder, initial clean up of ModuleBuilder.
[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 java.util.ArrayList;
11 import java.util.List;
12
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 import com.google.common.base.Preconditions;
18
19 /**
20  * Base helper implementation of Builders for Yang Model elements.
21  *
22  */
23 public abstract class AbstractBuilder implements Builder {
24     private 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<UnknownSchemaNodeBuilder>();
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     @Deprecated
44     public void setModuleName(final String moduleName) {
45         this.moduleName = moduleName;
46     }
47
48     @Override
49     public int getLine() {
50         return line;
51     }
52
53     @Override
54     public Builder getParent() {
55         return parentBuilder;
56     }
57
58     @Override
59     public void setParent(final Builder parentBuilder) {
60         checkNotSealed();
61         this.parentBuilder = parentBuilder;
62     }
63
64     @Override
65     public List<UnknownSchemaNodeBuilder> getUnknownNodes() {
66         return addedUnknownNodes;
67     }
68
69     @Override
70     public void addUnknownNodeBuilder(final UnknownSchemaNodeBuilder unknownNode) {
71         addedUnknownNodes.add(unknownNode);
72     }
73
74     protected void seal() {
75         checkNotSealed();
76         sealed  = true;
77     }
78
79     protected final void checkNotSealed() {
80         Preconditions.checkState(!sealed, "Builder is sealed. No further modifications allowed");
81     }
82
83     protected boolean isSealed() {
84         return sealed;
85     }
86
87 }