BUG-865: deprecate pre-Beryllium parser elements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / UsesNodeBuilderImpl.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.impl;
9
10 import com.google.common.collect.ImmutableList;
11 import com.google.common.collect.ImmutableMap;
12 import com.google.common.collect.ImmutableSet;
13 import java.util.ArrayList;
14 import java.util.HashMap;
15 import java.util.HashSet;
16 import java.util.List;
17 import java.util.Map;
18 import java.util.Objects;
19 import java.util.Set;
20 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
21 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
22 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
24 import org.opendaylight.yangtools.yang.model.api.UsesNode;
25 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
26 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
27 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
28 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
29 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
30 import org.opendaylight.yangtools.yang.parser.builder.api.RefineBuilder;
31 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
32 import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
33 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
34 import org.opendaylight.yangtools.yang.parser.builder.util.AbstractBuilder;
35 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
36
37 /**
38  * @deprecated Pre-Beryllium implementation, scheduled for removal.
39  */
40 @Deprecated
41 public final class UsesNodeBuilderImpl extends AbstractBuilder implements UsesNodeBuilder {
42     private UsesNodeImpl instance;
43     private DataNodeContainerBuilder parentBuilder;
44     private final SchemaPath targetGroupingPath;
45     private SchemaPath groupingPath;
46     private GroupingDefinition groupingDefinition;
47     private GroupingBuilder groupingBuilder;
48     private boolean addedByUses;
49     private boolean augmenting;
50     private boolean resolved;
51     private final Set<AugmentationSchemaBuilder> augmentationBuilders = new HashSet<>();
52     private final List<SchemaNodeBuilder> refineBuilders = new ArrayList<>();
53     private final List<RefineBuilder> refines = new ArrayList<>();
54
55     public UsesNodeBuilderImpl(final String moduleName, final int line, final SchemaPath targetGroupingPath) {
56         super(moduleName, line);
57         this.targetGroupingPath = targetGroupingPath;
58     }
59
60     @Override
61     public UsesNode build() {
62         if (instance != null) {
63             return instance;
64         }
65
66         instance = new UsesNodeImpl(groupingPath);
67         instance.setAddedByUses(addedByUses);
68
69         // AUGMENTATIONS
70         final Set<AugmentationSchema> augments = new HashSet<>();
71         for (AugmentationSchemaBuilder builder : augmentationBuilders) {
72             if (!builder.isUnsupportedTarget()) {
73                 augments.add(builder.build());
74             }
75         }
76         instance.augmentations = ImmutableSet.copyOf(augments);
77
78         // REFINES
79         final Map<SchemaPath, SchemaNode> refineNodes = new HashMap<>();
80         for (SchemaNodeBuilder refineBuilder : refineBuilders) {
81             SchemaNode refineNode = refineBuilder.build();
82             refineNodes.put(refineNode.getPath(), refineNode);
83         }
84         instance.refines = ImmutableMap.copyOf(refineNodes);
85
86         // UNKNOWN NODES
87         for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
88             unknownNodes.add(b.build());
89         }
90         instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
91
92         return instance;
93     }
94
95     @Override
96     public DataNodeContainerBuilder getParent() {
97         return parentBuilder;
98     }
99
100     @Override
101     public void setParent(final Builder parent) {
102         if (!(parent instanceof DataNodeContainerBuilder)) {
103             throw new YangParseException(getModuleName(), getLine(),
104                     "Parent of 'uses' has to be instance of DataNodeContainerBuilder, but was: '" + parent + "'.");
105         }
106         this.parentBuilder = (DataNodeContainerBuilder) parent;
107     }
108
109     @Override
110     public SchemaPath getGroupingPath() {
111         return groupingPath;
112     }
113
114     @Override
115     public GroupingDefinition getGroupingDefinition() {
116         return groupingDefinition;
117     }
118
119     @Override
120     public void setGroupingDefinition(final GroupingDefinition groupingDefinition) {
121         this.groupingDefinition = groupingDefinition;
122         if (groupingDefinition != null) {
123             this.groupingPath = groupingDefinition.getPath();
124         }
125     }
126
127     @Override
128     public GroupingBuilder getGroupingBuilder() {
129         return groupingBuilder;
130     }
131
132     @Override
133     public void setGrouping(final GroupingBuilder grouping) {
134         this.groupingBuilder = grouping;
135         if (groupingBuilder != null) {
136             this.groupingPath = groupingBuilder.getPath();
137         }
138     }
139
140     @Override
141     public SchemaPath getTargetGroupingPath() {
142         return targetGroupingPath;
143     }
144
145     @Override
146     public Set<AugmentationSchemaBuilder> getAugmentations() {
147         return augmentationBuilders;
148     }
149
150     @Override
151     public void addAugment(final AugmentationSchemaBuilder augmentBuilder) {
152         augmentationBuilders.add(augmentBuilder);
153     }
154
155     @Override
156     public boolean isAddedByUses() {
157         return addedByUses;
158     }
159
160     @Override
161     public void setAddedByUses(final boolean addedByUses) {
162         this.addedByUses = addedByUses;
163     }
164
165     @Override
166     public boolean isAugmenting() {
167         return augmenting;
168     }
169
170     @Override
171     public void setAugmenting(final boolean augmenting) {
172         this.augmenting = augmenting;
173     }
174
175     @Override
176     public boolean isResolved() {
177         return resolved;
178     }
179
180     @Override
181     public void setResolved(final boolean resolved) {
182         this.resolved = resolved;
183     }
184
185     @Override
186     public List<SchemaNodeBuilder> getRefineNodes() {
187         return refineBuilders;
188     }
189
190     @Override
191     public void addRefineNode(final DataSchemaNodeBuilder refineNode) {
192         refineBuilders.add(refineNode);
193     }
194
195     @Override
196     public List<RefineBuilder> getRefines() {
197         return refines;
198     }
199
200     @Override
201     public void addRefine(final RefineBuilder refine) {
202         refines.add(refine);
203     }
204
205     @Override
206     public int hashCode() {
207         final int prime = 31;
208         int result = 1;
209         result = prime * result + Objects.hashCode(groupingPath);
210         result = prime * result + Objects.hashCode(parentBuilder);
211         return result;
212     }
213
214     @Override
215     public boolean equals(final Object obj) {
216         if (this == obj) {
217             return true;
218         }
219         if (obj == null) {
220             return false;
221         }
222         if (getClass() != obj.getClass()) {
223             return false;
224         }
225         UsesNodeBuilderImpl other = (UsesNodeBuilderImpl) obj;
226         if (groupingPath == null) {
227             if (other.groupingPath != null) {
228                 return false;
229             }
230         } else if (!groupingPath.equals(other.groupingPath)) {
231             return false;
232         }
233         if (parentBuilder == null) {
234             if (other.parentBuilder != null) {
235                 return false;
236             }
237         } else if (!parentBuilder.equals(other.parentBuilder)) {
238             return false;
239         }
240         return true;
241     }
242
243     @Override
244     public String toString() {
245         return "uses '" + groupingPath + "'";
246     }
247
248 }