2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.builder.impl;
10 import org.opendaylight.yangtools.yang.common.QName;
11 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
12 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
13 import org.opendaylight.yangtools.yang.model.api.Deviation;
14 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
15 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
16 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
17 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
18 import org.opendaylight.yangtools.yang.model.api.Module;
19 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
20 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
21 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
22 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
23 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
24 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.UsesNode;
26 import org.opendaylight.yangtools.yang.parser.builder.api.AbstractDataNodeContainerBuilder;
27 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
28 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
29 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
30 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
31 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
32 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
33 import org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder;
34 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
35 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
36 import org.opendaylight.yangtools.yang.parser.util.Comparators;
37 import org.opendaylight.yangtools.yang.parser.util.ModuleImportImpl;
38 import org.opendaylight.yangtools.yang.parser.util.RefineHolder;
39 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
42 import java.util.ArrayList;
43 import java.util.Collections;
44 import java.util.Date;
45 import java.util.Deque;
46 import java.util.HashSet;
47 import java.util.LinkedList;
48 import java.util.List;
50 import java.util.TreeSet;
53 * Builder of Module object. If this module is dependent on external
54 * module/modules, these dependencies must be resolved before module is built,
55 * otherwise result may not be valid.
57 public class ModuleBuilder extends AbstractDataNodeContainerBuilder {
59 private final ModuleImpl instance;
60 private final String name;
61 private final String sourcePath;
62 private final SchemaPath schemaPath;
63 private URI namespace;
64 private String prefix;
65 private Date revision;
67 private final boolean submodule;
68 private String belongsTo;
69 private ModuleBuilder parent;
71 public ModuleBuilder getParent() {
75 public void setParent(ModuleBuilder parent) {
79 private final Deque<Builder> actualPath = new LinkedList<>();
80 private final Set<TypeAwareBuilder> dirtyNodes = new HashSet<>();
82 private final Set<ModuleImport> imports = new HashSet<ModuleImport>();
84 private final Set<AugmentationSchema> augments = new HashSet<>();
85 private final List<AugmentationSchemaBuilder> augmentBuilders = new ArrayList<>();
86 private final List<AugmentationSchemaBuilder> allAugments = new ArrayList<>();
88 private final List<GroupingBuilder> allGroupings = new ArrayList<>();
90 private final List<UsesNodeBuilder> allUsesNodes = new ArrayList<>();
92 private final Set<RpcDefinition> rpcs = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
93 private final Set<RpcDefinitionBuilder> addedRpcs = new HashSet<>();
95 private final Set<NotificationDefinition> notifications = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
96 private final Set<NotificationBuilder> addedNotifications = new HashSet<>();
98 private final Set<IdentitySchemaNode> identities = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
99 private final Set<IdentitySchemaNodeBuilder> addedIdentities = new HashSet<>();
101 private final Set<FeatureDefinition> features = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
102 private final Set<FeatureBuilder> addedFeatures = new HashSet<>();
104 private final Set<Deviation> deviations = new HashSet<>();
105 private final Set<DeviationBuilder> deviationBuilders = new HashSet<>();
107 private final List<ExtensionDefinition> extensions = new ArrayList<>();
108 private final List<ExtensionBuilder> addedExtensions = new ArrayList<>();
110 private final List<UnknownSchemaNodeBuilder> allUnknownNodes = new ArrayList<UnknownSchemaNodeBuilder>();
112 private final List<ListSchemaNodeBuilder> allLists = new ArrayList<ListSchemaNodeBuilder>();
114 private String source;
116 public ModuleBuilder(final String name, final String sourcePath) {
117 this(name, false, sourcePath);
120 public ModuleBuilder(final String name, final boolean submodule, final String sourcePath) {
121 super(name, 0, null);
123 this.sourcePath = sourcePath;
124 schemaPath = new SchemaPath(Collections.<QName> emptyList(), true);
125 this.submodule = submodule;
126 instance = new ModuleImpl(name, sourcePath);
127 actualPath.push(this);
130 public ModuleBuilder(Module base) {
131 super(base.getName(), 0, null);
132 this.name = base.getName();
133 this.sourcePath = base.getModuleSourcePath();
134 schemaPath = new SchemaPath(Collections.<QName> emptyList(), true);
136 instance = new ModuleImpl(base.getName(), base.getModuleSourcePath());
137 actualPath.push(this);
138 namespace = base.getNamespace();
139 prefix = base.getPrefix();
140 revision = base.getRevision();
142 for (DataSchemaNode childNode : base.getChildNodes()) {
143 childNodes.add(childNode);
146 typedefs.addAll(base.getTypeDefinitions());
147 groupings.addAll(base.getGroupings());
148 usesNodes.addAll(base.getUses());
149 augments.addAll(base.getAugmentations());
150 rpcs.addAll(base.getRpcs());
151 notifications.addAll(base.getNotifications());
152 identities.addAll(base.getIdentities());
153 features.addAll(base.getFeatures());
154 deviations.addAll(base.getDeviations());
155 extensions.addAll(base.getExtensionSchemaNodes());
156 unknownNodes.addAll(base.getUnknownSchemaNodes());
160 * Build new Module object based on this builder.
163 public Module build() {
164 instance.setPrefix(prefix);
165 instance.setRevision(revision);
166 instance.setImports(imports);
167 instance.setNamespace(namespace);
170 for (TypeDefinitionBuilder tdb : addedTypedefs) {
171 typedefs.add(tdb.build());
173 instance.setTypeDefinitions(typedefs);
176 for (DataSchemaNodeBuilder child : addedChildNodes) {
177 childNodes.add(child.build());
179 instance.addChildNodes(childNodes);
182 for (GroupingBuilder gb : addedGroupings) {
183 groupings.add(gb.build());
185 instance.setGroupings(groupings);
188 for (UsesNodeBuilder unb : addedUsesNodes) {
189 usesNodes.add(unb.build());
191 instance.setUses(usesNodes);
194 for (FeatureBuilder fb : addedFeatures) {
195 features.add(fb.build());
197 instance.setFeatures(features);
200 for (NotificationBuilder entry : addedNotifications) {
201 notifications.add(entry.build());
203 instance.setNotifications(notifications);
206 for (AugmentationSchemaBuilder builder : augmentBuilders) {
207 augments.add(builder.build());
209 instance.setAugmentations(augments);
212 for (RpcDefinitionBuilder rpc : addedRpcs) {
213 rpcs.add(rpc.build());
215 instance.setRpcs(rpcs);
218 for (DeviationBuilder entry : deviationBuilders) {
219 deviations.add(entry.build());
221 instance.setDeviations(deviations);
224 for (ExtensionBuilder eb : addedExtensions) {
225 extensions.add(eb.build());
227 Collections.sort(extensions, Comparators.SCHEMA_NODE_COMP);
228 instance.setExtensionSchemaNodes(extensions);
231 for (IdentitySchemaNodeBuilder id : addedIdentities) {
232 identities.add(id.build());
234 instance.setIdentities(identities);
237 for (UnknownSchemaNodeBuilder unb : addedUnknownNodes) {
238 unknownNodes.add(unb.build());
240 Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
241 instance.setUnknownSchemaNodes(unknownNodes);
243 instance.setSource(source);
248 public String getModuleSourcePath() {
253 public void setParent(Builder parent) {
254 throw new YangParseException(name, 0, "Can not set parent to module");
258 public SchemaPath getPath() {
263 public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
264 return addedTypedefs;
267 public void enterNode(final Builder node) {
268 actualPath.push(node);
271 public void exitNode() {
275 public Builder getActualNode() {
276 if (actualPath.isEmpty()) {
279 return actualPath.peekFirst();
283 public Set<TypeAwareBuilder> getDirtyNodes() {
287 public Set<AugmentationSchema> getAugments() {
291 public List<AugmentationSchemaBuilder> getAugmentBuilders() {
292 return augmentBuilders;
295 public List<AugmentationSchemaBuilder> getAllAugments() {
299 public Set<IdentitySchemaNode> getIdentities() {
303 public Set<IdentitySchemaNodeBuilder> getAddedIdentities() {
304 return addedIdentities;
307 public Set<FeatureDefinition> getFeatures() {
311 public Set<FeatureBuilder> getAddedFeatures() {
312 return addedFeatures;
315 public List<GroupingBuilder> getAllGroupings() {
319 public List<UsesNodeBuilder> getAllUsesNodes() {
323 public Set<Deviation> getDeviations() {
327 public Set<DeviationBuilder> getDeviationBuilders() {
328 return deviationBuilders;
331 public List<ExtensionDefinition> getExtensions() {
335 public List<ExtensionBuilder> getAddedExtensions() {
336 return addedExtensions;
339 public List<UnknownSchemaNodeBuilder> getAllUnknownNodes() {
340 return allUnknownNodes;
343 public List<ListSchemaNodeBuilder> getAllLists() {
347 public String getName() {
351 public URI getNamespace() {
355 public void setNamespace(final URI namespace) {
356 this.namespace = namespace;
359 public String getPrefix() {
363 public Date getRevision() {
367 public boolean isSubmodule() {
371 public String getBelongsTo() {
375 public void setBelongsTo(String belongsTo) {
376 this.belongsTo = belongsTo;
379 public void markActualNodeDirty() {
380 final TypeAwareBuilder nodeBuilder = (TypeAwareBuilder) getActualNode();
381 dirtyNodes.add(nodeBuilder);
384 public void setRevision(final Date revision) {
385 this.revision = revision;
388 public void setPrefix(final String prefix) {
389 this.prefix = prefix;
392 public void setYangVersion(final String yangVersion) {
393 instance.setYangVersion(yangVersion);
396 public void setDescription(final String description) {
397 instance.setDescription(description);
400 public void setReference(final String reference) {
401 instance.setReference(reference);
404 public void setOrganization(final String organization) {
405 instance.setOrganization(organization);
408 public void setContact(final String contact) {
409 instance.setContact(contact);
412 public boolean addModuleImport(final String moduleName, final Date revision, final String prefix) {
413 final ModuleImport moduleImport = createModuleImport(moduleName, revision, prefix);
414 return imports.add(moduleImport);
417 public Set<ModuleImport> getModuleImports() {
421 public ExtensionBuilder addExtension(final QName qname, final int line, final SchemaPath path) {
422 Builder parent = getActualNode();
423 if (!(parent.equals(this))) {
424 throw new YangParseException(name, line, "extension can be defined only in module or submodule");
427 final String extName = qname.getLocalName();
428 for (ExtensionBuilder addedExtension : addedExtensions) {
429 if (addedExtension.getQName().getLocalName().equals(extName)) {
430 raiseYangParserException("extension", "node", extName, line, addedExtension.getLine());
433 final ExtensionBuilder builder = new ExtensionBuilder(name, line, qname, path);
434 builder.setParent(parent);
435 addedExtensions.add(builder);
439 public ContainerSchemaNodeBuilder addContainerNode(final int line, final QName qname, final SchemaPath schemaPath) {
440 final ContainerSchemaNodeBuilder builder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
442 Builder parent = getActualNode();
443 builder.setParent(parent);
444 addChildToParent(parent, builder, qname.getLocalName());
449 public ListSchemaNodeBuilder addListNode(final int line, final QName qname, final SchemaPath schemaPath) {
450 final ListSchemaNodeBuilder builder = new ListSchemaNodeBuilder(name, line, qname, schemaPath);
452 Builder parent = getActualNode();
453 builder.setParent(parent);
454 addChildToParent(parent, builder, qname.getLocalName());
455 allLists.add(builder);
460 public LeafSchemaNodeBuilder addLeafNode(final int line, final QName qname, final SchemaPath schemaPath) {
461 final LeafSchemaNodeBuilder builder = new LeafSchemaNodeBuilder(name, line, qname, schemaPath);
463 Builder parent = getActualNode();
464 builder.setParent(parent);
465 addChildToParent(parent, builder, qname.getLocalName());
470 public LeafListSchemaNodeBuilder addLeafListNode(final int line, final QName qname, final SchemaPath schemaPath) {
471 final LeafListSchemaNodeBuilder builder = new LeafListSchemaNodeBuilder(name, line, qname, schemaPath);
473 Builder parent = getActualNode();
474 builder.setParent(parent);
475 addChildToParent(parent, builder, qname.getLocalName());
480 public GroupingBuilder addGrouping(final int line, final QName qname, final SchemaPath path) {
481 final GroupingBuilder builder = new GroupingBuilderImpl(name, line, qname, path);
483 Builder parent = getActualNode();
484 builder.setParent(parent);
486 String groupingName = qname.getLocalName();
487 if (parent.equals(this)) {
488 for (GroupingBuilder addedGrouping : addedGroupings) {
489 if (addedGrouping.getQName().getLocalName().equals(groupingName)) {
490 raiseYangParserException("", "Grouping", groupingName, line, addedGrouping.getLine());
493 addedGroupings.add(builder);
495 if (parent instanceof DataNodeContainerBuilder) {
496 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
497 for (GroupingBuilder addedGrouping : parentNode.getGroupingBuilders()) {
498 if (addedGrouping.getQName().getLocalName().equals(groupingName)) {
499 raiseYangParserException("", "Grouping", groupingName, line, addedGrouping.getLine());
502 parentNode.addGrouping(builder);
503 } else if (parent instanceof RpcDefinitionBuilder) {
504 RpcDefinitionBuilder parentNode = (RpcDefinitionBuilder) parent;
505 for (GroupingBuilder child : parentNode.getGroupings()) {
506 if (child.getQName().getLocalName().equals(groupingName)) {
507 raiseYangParserException("", "Grouping", groupingName, line, child.getLine());
510 parentNode.addGrouping(builder);
512 throw new YangParseException(name, line, "Unresolved parent of grouping " + groupingName);
516 allGroupings.add(builder);
520 public AugmentationSchemaBuilder addAugment(final int line, final String augmentTargetStr) {
521 final AugmentationSchemaBuilder builder = new AugmentationSchemaBuilderImpl(name, line, augmentTargetStr);
523 Builder parent = getActualNode();
524 builder.setParent(parent);
526 if (parent.equals(this)) {
527 // augment can be declared only under 'module' ...
528 if (!(augmentTargetStr.startsWith("/"))) {
529 throw new YangParseException(
532 "If the 'augment' statement is on the top level in a module, the absolute form of a schema node identifier MUST be used.");
534 augmentBuilders.add(builder);
536 // ... or 'uses' statement
537 if (parent instanceof UsesNodeBuilder) {
538 if (augmentTargetStr.startsWith("/")) {
539 throw new YangParseException(name, line,
540 "If 'augment' statement is a substatement to the 'uses' statement, it cannot contain absolute path ("
541 + augmentTargetStr + ")");
543 ((UsesNodeBuilder) parent).addAugment(builder);
545 throw new YangParseException(name, line, "Augment can be declared only under module or uses statement.");
548 allAugments.add(builder);
554 public void addUsesNode(UsesNodeBuilder usesBuilder) {
555 addedUsesNodes.add(usesBuilder);
556 allUsesNodes.add(usesBuilder);
559 public UsesNodeBuilder addUsesNode(final int line, final String groupingPathStr) {
560 final UsesNodeBuilder usesBuilder = new UsesNodeBuilderImpl(name, line, groupingPathStr);
562 Builder parent = getActualNode();
563 usesBuilder.setParent(parent);
565 if (parent.equals(this)) {
566 addedUsesNodes.add(usesBuilder);
568 if (!(parent instanceof DataNodeContainerBuilder)) {
569 throw new YangParseException(name, line, "Unresolved parent of uses '" + groupingPathStr + "'.");
571 ((DataNodeContainerBuilder) parent).addUsesNode(usesBuilder);
573 if (parent instanceof AugmentationSchemaBuilder) {
574 usesBuilder.setAugmenting(true);
577 allUsesNodes.add(usesBuilder);
581 public void addRefine(final RefineHolder refine) {
582 final Builder parent = getActualNode();
583 if (!(parent instanceof UsesNodeBuilder)) {
584 throw new YangParseException(name, refine.getLine(), "refine can be defined only in uses statement");
586 ((UsesNodeBuilder) parent).addRefine(refine);
587 refine.setParent(parent);
590 public RpcDefinitionBuilder addRpc(final int line, final QName qname, final SchemaPath path) {
591 Builder parent = getActualNode();
592 if (!(parent.equals(this))) {
593 throw new YangParseException(name, line, "rpc can be defined only in module or submodule");
596 final RpcDefinitionBuilder rpcBuilder = new RpcDefinitionBuilder(name, line, qname, path);
597 rpcBuilder.setParent(parent);
599 String rpcName = qname.getLocalName();
600 for (RpcDefinitionBuilder rpc : addedRpcs) {
601 if (rpc.getQName().getLocalName().equals(rpcName)) {
602 raiseYangParserException("", "rpc", rpcName, line, rpc.getLine());
605 for (DataSchemaNodeBuilder addedChild : addedChildNodes) {
606 if (addedChild.getQName().getLocalName().equals(rpcName)) {
607 raiseYangParserException("rpc", "node", rpcName, line, addedChild.getLine());
610 for (NotificationBuilder addedNotification : addedNotifications) {
611 if (addedNotification.getQName().getLocalName().equals(rpcName)) {
612 raiseYangParserException("rpc", "notification", rpcName, line, addedNotification.getLine());
615 addedRpcs.add(rpcBuilder);
619 public ContainerSchemaNodeBuilder addRpcInput(final int line, final QName qname, final SchemaPath schemaPath) {
620 final Builder parent = getActualNode();
621 if (!(parent instanceof RpcDefinitionBuilder)) {
622 throw new YangParseException(name, line, "input can be defined only in rpc statement");
624 final RpcDefinitionBuilder rpc = (RpcDefinitionBuilder) parent;
626 final ContainerSchemaNodeBuilder inputBuilder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
627 inputBuilder.setParent(rpc);
629 rpc.setInput(inputBuilder);
633 public ContainerSchemaNodeBuilder addRpcOutput(final SchemaPath schemaPath, final QName qname, final int line) {
634 final Builder parent = getActualNode();
635 if (!(parent instanceof RpcDefinitionBuilder)) {
636 throw new YangParseException(name, line, "output can be defined only in rpc statement");
638 final RpcDefinitionBuilder rpc = (RpcDefinitionBuilder) parent;
640 final ContainerSchemaNodeBuilder outputBuilder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
641 outputBuilder.setParent(rpc);
643 rpc.setOutput(outputBuilder);
644 return outputBuilder;
647 public void addNotification(NotificationDefinition notification) {
648 notifications.add(notification);
651 public NotificationBuilder addNotification(final int line, final QName qname, final SchemaPath path) {
652 final Builder parent = getActualNode();
653 if (!(parent.equals(this))) {
654 throw new YangParseException(name, line, "notification can be defined only in module or submodule");
657 String notificationName = qname.getLocalName();
658 for (NotificationBuilder nb : addedNotifications) {
659 if (nb.getQName().equals(qname)) {
660 raiseYangParserException("", "notification", notificationName, line, nb.getLine());
663 for (RpcDefinitionBuilder rpc : addedRpcs) {
664 if (rpc.getQName().getLocalName().equals(notificationName)) {
665 raiseYangParserException("notification", "rpc", notificationName, line, rpc.getLine());
668 for (DataSchemaNodeBuilder addedChild : addedChildNodes) {
669 if (addedChild.getQName().getLocalName().equals(notificationName)) {
670 raiseYangParserException("notification", "node", notificationName, line, addedChild.getLine());
674 final NotificationBuilder builder = new NotificationBuilder(name, line, qname, path);
675 builder.setParent(parent);
676 addedNotifications.add(builder);
681 public FeatureBuilder addFeature(final int line, final QName qname, final SchemaPath path) {
682 Builder parent = getActualNode();
683 if (!(parent.equals(this))) {
684 throw new YangParseException(name, line, "feature can be defined only in module or submodule");
687 final FeatureBuilder builder = new FeatureBuilder(name, line, qname, path);
688 builder.setParent(parent);
690 String featureName = qname.getLocalName();
691 for (FeatureBuilder addedFeature : addedFeatures) {
692 if (addedFeature.getQName().getLocalName().equals(featureName)) {
693 raiseYangParserException("", "feature", featureName, line, addedFeature.getLine());
696 addedFeatures.add(builder);
700 public ChoiceBuilder addChoice(final int line, final QName qname, final SchemaPath path) {
701 final ChoiceBuilder builder = new ChoiceBuilder(name, line, qname, path);
703 Builder parent = getActualNode();
704 builder.setParent(parent);
705 addChildToParent(parent, builder, qname.getLocalName());
710 public ChoiceCaseBuilder addCase(final int line, final QName qname, final SchemaPath path) {
711 Builder parent = getActualNode();
712 if (parent == null || parent.equals(this)) {
713 throw new YangParseException(name, line, "'case' parent not found");
716 final ChoiceCaseBuilder builder = new ChoiceCaseBuilder(name, line, qname, path);
717 builder.setParent(parent);
719 if (parent instanceof ChoiceBuilder) {
720 ((ChoiceBuilder) parent).addCase(builder);
721 } else if (parent instanceof AugmentationSchemaBuilder) {
722 ((AugmentationSchemaBuilder) parent).addChildNode(builder);
724 throw new YangParseException(name, line, "Unresolved parent of 'case' " + qname.getLocalName());
730 public AnyXmlBuilder addAnyXml(final int line, final QName qname, final SchemaPath schemaPath) {
731 final AnyXmlBuilder builder = new AnyXmlBuilder(name, line, qname, schemaPath);
733 Builder parent = getActualNode();
734 builder.setParent(parent);
735 addChildToParent(parent, builder, qname.getLocalName());
741 public void addTypedef(TypeDefinitionBuilder typedefBuilder) {
742 String nodeName = typedefBuilder.getQName().getLocalName();
743 for (TypeDefinitionBuilder tdb : addedTypedefs) {
744 if (tdb.getQName().getLocalName().equals(nodeName)) {
745 raiseYangParserException("", "typedef", nodeName, typedefBuilder.getLine(), tdb.getLine());
748 addedTypedefs.add(typedefBuilder);
751 public TypeDefinitionBuilderImpl addTypedef(final int line, final QName qname, final SchemaPath path) {
752 final TypeDefinitionBuilderImpl builder = new TypeDefinitionBuilderImpl(name, line, qname, path);
754 Builder parent = getActualNode();
755 builder.setParent(parent);
757 String typedefName = qname.getLocalName();
758 if (parent.equals(this)) {
759 for (TypeDefinitionBuilder tdb : addedTypedefs) {
760 if (tdb.getQName().getLocalName().equals(typedefName)) {
761 raiseYangParserException("", "typedef", typedefName, line, tdb.getLine());
764 addedTypedefs.add(builder);
766 if (parent instanceof DataNodeContainerBuilder) {
767 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
768 for (TypeDefinitionBuilder child : parentNode.getTypeDefinitionBuilders()) {
769 if (child.getQName().getLocalName().equals(typedefName)) {
770 raiseYangParserException("", "typedef", typedefName, line, child.getLine());
773 parentNode.addTypedef(builder);
774 } else if (parent instanceof RpcDefinitionBuilder) {
775 RpcDefinitionBuilder rpcParent = (RpcDefinitionBuilder) parent;
776 for (TypeDefinitionBuilder tdb : rpcParent.getTypeDefinitions()) {
777 if (tdb.getQName().getLocalName().equals(builder.getQName().getLocalName())) {
778 raiseYangParserException("", "typedef", typedefName, line, tdb.getLine());
781 rpcParent.addTypedef(builder);
783 throw new YangParseException(name, line, "Unresolved parent of typedef " + typedefName);
790 public void setType(final TypeDefinition<?> type) {
791 Builder parent = getActualNode();
792 if (!(parent instanceof TypeAwareBuilder)) {
793 throw new YangParseException("Failed to set type '" + type.getQName().getLocalName()
794 + "'. Invalid parent node: " + parent);
796 ((TypeAwareBuilder) parent).setType(type);
799 public UnionTypeBuilder addUnionType(final int line, final URI namespace, final Date revision) {
800 final Builder parent = getActualNode();
801 if (parent == null) {
802 throw new YangParseException(name, line, "Unresolved parent of union type");
804 final UnionTypeBuilder union = new UnionTypeBuilder(name, line);
805 if (parent instanceof TypeAwareBuilder) {
806 ((TypeAwareBuilder) parent).setTypedef(union);
809 throw new YangParseException(name, line, "Invalid parent of union type.");
814 public void addIdentityrefType(final int line, final SchemaPath schemaPath, final String baseString) {
815 final IdentityrefTypeBuilder identityref = new IdentityrefTypeBuilder(name, line, baseString, schemaPath);
817 final Builder parent = getActualNode();
818 if (parent == null) {
819 throw new YangParseException(name, line, "Unresolved parent of identityref type.");
821 if (parent instanceof TypeAwareBuilder) {
822 final TypeAwareBuilder typeParent = (TypeAwareBuilder) parent;
823 typeParent.setTypedef(identityref);
824 dirtyNodes.add(typeParent);
826 throw new YangParseException(name, line, "Invalid parent of identityref type.");
831 public DeviationBuilder addDeviation(final int line, final String targetPath) {
832 Builder parent = getActualNode();
833 if (!(parent.equals(this))) {
834 throw new YangParseException(name, line, "deviation can be defined only in module or submodule");
837 final DeviationBuilder builder = new DeviationBuilder(name, line, targetPath);
838 builder.setParent(parent);
839 deviationBuilders.add(builder);
843 public IdentitySchemaNodeBuilder addIdentity(final QName qname, final int line, final SchemaPath path) {
844 Builder parent = getActualNode();
845 if (!(parent.equals(this))) {
846 throw new YangParseException(name, line, "identity can be defined only in module or submodule");
848 String identityName = qname.getLocalName();
849 for (IdentitySchemaNodeBuilder idBuilder : addedIdentities) {
850 if (idBuilder.getQName().equals(qname)) {
851 raiseYangParserException("", "identity", identityName, line, idBuilder.getLine());
855 final IdentitySchemaNodeBuilder builder = new IdentitySchemaNodeBuilder(name, line, qname, path);
856 builder.setParent(parent);
857 addedIdentities.add(builder);
862 public void addUnknownNodeBuilder(final UnknownSchemaNodeBuilder builder) {
863 addedUnknownNodes.add(builder);
864 allUnknownNodes.add(builder);
867 public UnknownSchemaNodeBuilder addUnknownSchemaNode(final int line, final QName qname, final SchemaPath path) {
868 final Builder parent = getActualNode();
869 final UnknownSchemaNodeBuilder builder = new UnknownSchemaNodeBuilder(name, line, qname, path);
870 builder.setParent(parent);
871 allUnknownNodes.add(builder);
873 if (parent.equals(this)) {
874 addedUnknownNodes.add(builder);
876 if (parent instanceof SchemaNodeBuilder) {
877 ((SchemaNodeBuilder) parent).addUnknownNodeBuilder(builder);
878 } else if (parent instanceof DataNodeContainerBuilder) {
879 ((DataNodeContainerBuilder) parent).addUnknownNodeBuilder(builder);
880 } else if (parent instanceof RefineHolder) {
881 ((RefineHolder) parent).addUnknownNodeBuilder(builder);
883 throw new YangParseException(name, line, "Unresolved parent of unknown node '" + qname.getLocalName()
891 public Set<RpcDefinition> getRpcs() {
895 public Set<RpcDefinitionBuilder> getAddedRpcs() {
899 public Set<NotificationDefinition> getNotifications() {
900 return notifications;
903 public Set<NotificationBuilder> getAddedNotifications() {
904 return addedNotifications;
908 public String toString() {
909 return "module " + name;
912 public void setSource(String source) {
913 this.source = source;
916 public static final class ModuleImpl implements Module {
917 private URI namespace;
918 private final String name;
919 private final String sourcePath;
920 private Date revision;
921 private String prefix;
922 private String yangVersion;
923 private String description;
924 private String reference;
925 private String organization;
926 private String contact;
927 private final Set<ModuleImport> imports = new HashSet<>();
928 private final Set<FeatureDefinition> features = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
929 private final Set<TypeDefinition<?>> typeDefinitions = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
930 private final Set<NotificationDefinition> notifications = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
931 private final Set<AugmentationSchema> augmentations = new HashSet<>();
932 private final Set<RpcDefinition> rpcs = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
933 private final Set<Deviation> deviations = new HashSet<>();
934 private final Set<DataSchemaNode> childNodes = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
935 private final Set<GroupingDefinition> groupings = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
936 private final Set<UsesNode> uses = new HashSet<>();
937 private final List<ExtensionDefinition> extensionNodes = new ArrayList<>();
938 private final Set<IdentitySchemaNode> identities = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
939 private final List<UnknownSchemaNode> unknownNodes = new ArrayList<>();
940 private String source;
942 private ModuleImpl(String name, String sourcePath) {
944 this.sourcePath = sourcePath;
948 public String getModuleSourcePath() {
953 public URI getNamespace() {
957 private void setNamespace(URI namespace) {
958 this.namespace = namespace;
962 public String getName() {
967 public Date getRevision() {
971 private void setRevision(Date revision) {
972 this.revision = revision;
976 public String getPrefix() {
980 private void setPrefix(String prefix) {
981 this.prefix = prefix;
985 public String getYangVersion() {
989 private void setYangVersion(String yangVersion) {
990 this.yangVersion = yangVersion;
994 public String getDescription() {
998 private void setDescription(String description) {
999 this.description = description;
1003 public String getReference() {
1007 private void setReference(String reference) {
1008 this.reference = reference;
1012 public String getOrganization() {
1013 return organization;
1016 private void setOrganization(String organization) {
1017 this.organization = organization;
1021 public String getContact() {
1025 private void setContact(String contact) {
1026 this.contact = contact;
1030 public Set<ModuleImport> getImports() {
1034 private void setImports(Set<ModuleImport> imports) {
1035 if (imports != null) {
1036 this.imports.addAll(imports);
1041 public Set<FeatureDefinition> getFeatures() {
1045 private void setFeatures(Set<FeatureDefinition> features) {
1046 if (features != null) {
1047 this.features.addAll(features);
1052 public Set<TypeDefinition<?>> getTypeDefinitions() {
1053 return typeDefinitions;
1056 private void setTypeDefinitions(Set<TypeDefinition<?>> typeDefinitions) {
1057 if (typeDefinitions != null) {
1058 this.typeDefinitions.addAll(typeDefinitions);
1063 public Set<NotificationDefinition> getNotifications() {
1064 return notifications;
1067 private void setNotifications(Set<NotificationDefinition> notifications) {
1068 if (notifications != null) {
1069 this.notifications.addAll(notifications);
1074 public Set<AugmentationSchema> getAugmentations() {
1075 return augmentations;
1078 private void setAugmentations(Set<AugmentationSchema> augmentations) {
1079 if (augmentations != null) {
1080 this.augmentations.addAll(augmentations);
1085 public Set<RpcDefinition> getRpcs() {
1089 private void setRpcs(Set<RpcDefinition> rpcs) {
1091 this.rpcs.addAll(rpcs);
1096 public Set<Deviation> getDeviations() {
1100 private void setDeviations(Set<Deviation> deviations) {
1101 if (deviations != null) {
1102 this.deviations.addAll(deviations);
1107 public Set<DataSchemaNode> getChildNodes() {
1108 return Collections.unmodifiableSet(childNodes);
1111 private void addChildNodes(Set<DataSchemaNode> childNodes) {
1112 if (childNodes != null) {
1113 this.childNodes.addAll(childNodes);
1118 public Set<GroupingDefinition> getGroupings() {
1122 private void setGroupings(Set<GroupingDefinition> groupings) {
1123 if (groupings != null) {
1124 this.groupings.addAll(groupings);
1129 public Set<UsesNode> getUses() {
1133 private void setUses(Set<UsesNode> uses) {
1135 this.uses.addAll(uses);
1140 public List<ExtensionDefinition> getExtensionSchemaNodes() {
1141 Collections.sort(extensionNodes, Comparators.SCHEMA_NODE_COMP);
1142 return extensionNodes;
1145 private void setExtensionSchemaNodes(final List<ExtensionDefinition> extensionNodes) {
1146 if (extensionNodes != null) {
1147 this.extensionNodes.addAll(extensionNodes);
1152 public Set<IdentitySchemaNode> getIdentities() {
1156 private void setIdentities(final Set<IdentitySchemaNode> identities) {
1157 if (identities != null) {
1158 this.identities.addAll(identities);
1163 public List<UnknownSchemaNode> getUnknownSchemaNodes() {
1164 return unknownNodes;
1167 private void setUnknownSchemaNodes(final List<UnknownSchemaNode> unknownNodes) {
1168 if (unknownNodes != null) {
1169 this.unknownNodes.addAll(unknownNodes);
1174 public DataSchemaNode getDataChildByName(QName name) {
1175 return getChildNode(childNodes, name);
1179 public DataSchemaNode getDataChildByName(String name) {
1180 return getChildNode(childNodes, name);
1183 void setSource(String source){
1184 this.source = source;
1187 public String getSource() {
1191 // FIXME: prefix should not be taken into consideration, perhaps namespace too
1193 public int hashCode() {
1194 final int prime = 31;
1196 result = prime * result + ((namespace == null) ? 0 : namespace.hashCode());
1197 result = prime * result + ((name == null) ? 0 : name.hashCode());
1198 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
1199 result = prime * result + ((prefix == null) ? 0 : prefix.hashCode());
1200 result = prime * result + ((yangVersion == null) ? 0 : yangVersion.hashCode());
1205 public boolean equals(Object obj) {
1212 if (getClass() != obj.getClass()) {
1215 ModuleImpl other = (ModuleImpl) obj;
1216 if (namespace == null) {
1217 if (other.namespace != null) {
1220 } else if (!namespace.equals(other.namespace)) {
1224 if (other.name != null) {
1227 } else if (!name.equals(other.name)) {
1230 if (revision == null) {
1231 if (other.revision != null) {
1234 } else if (!revision.equals(other.revision)) {
1237 if (prefix == null) {
1238 if (other.prefix != null) {
1241 } else if (!prefix.equals(other.prefix)) {
1244 if (yangVersion == null) {
1245 if (other.yangVersion != null) {
1248 } else if (!yangVersion.equals(other.yangVersion)) {
1255 public String toString() {
1256 StringBuilder sb = new StringBuilder(ModuleImpl.class.getSimpleName());
1258 sb.append("name=" + name);
1259 sb.append(", namespace=" + namespace);
1260 sb.append(", revision=" + revision);
1261 sb.append(", prefix=" + prefix);
1262 sb.append(", yangVersion=" + yangVersion);
1264 return sb.toString();
1269 * Add child to parent. Method checks for duplicates and add given child
1270 * node to parent. If node with same name is found, throws exception. If
1271 * parent is null, child node will be added directly to module.
1277 private void addChildToParent(final Builder parent, final DataSchemaNodeBuilder child, final String childName) {
1278 final int lineNum = child.getLine();
1279 if (parent.equals(this)) {
1280 addChildToModule(child, childName, lineNum);
1282 addChildToSubnodeOfModule(parent, child, childName, lineNum);
1287 * Adds child node <code>child</code> to the set of nodes child nodes.
1289 * The method reduces the complexity of the method
1290 * {@link #addChildToParent(Builder, DataSchemaNodeBuilder, String)
1291 * addChildToParent}.
1294 * data schema node builder for child node
1296 * string with name of child node
1298 * line number in YANG file where is the node with the name equal
1299 * to <code>childName</code> is defined
1301 private void addChildToModule(final DataSchemaNodeBuilder child, final String childName, final int lineNum) {
1302 // if parent == null => node is defined under module
1303 // All leafs, leaf-lists, lists, containers, choices, rpcs,
1304 // notifications, and anyxmls defined within a parent node or at the
1305 // top level of the module or its submodules share the same
1306 // identifier namespace.
1307 for (DataSchemaNodeBuilder childNode : addedChildNodes) {
1308 if (childNode.getQName().getLocalName().equals(childName)) {
1309 raiseYangParserException("'" + child + "'", "node", childName, lineNum, childNode.getLine());
1312 for (RpcDefinitionBuilder rpc : addedRpcs) {
1313 if (rpc.getQName().getLocalName().equals(childName)) {
1314 raiseYangParserException("'" + child + "'", "rpc", childName, lineNum, rpc.getLine());
1317 for (NotificationBuilder notification : addedNotifications) {
1318 if (notification.getQName().getLocalName().equals(childName)) {
1319 raiseYangParserException("'" + child + "'", "notification", childName, lineNum, notification.getLine());
1322 addedChildNodes.add(child);
1326 * Adds child node <code>child</code> to the group of child nodes of the
1327 * <code>parent</code>
1329 * The method reduces the complexity of the method
1330 * {@link #addChildToParent(Builder, DataSchemaNodeBuilder, String)
1331 * addChildToParent}. *
1334 * builder of node which is parent for <code>child</code>
1336 * data schema node builder for child node
1338 * string with name of child node
1340 * line number in YANG file where is the node with the name equal
1341 * to <code>childName</code> is defined
1343 private void addChildToSubnodeOfModule(final Builder parent, final DataSchemaNodeBuilder child,
1344 final String childName, final int lineNum) {
1345 // no need for checking rpc and notification because they can be
1346 // defined only under module or submodule
1347 if (parent instanceof DataNodeContainerBuilder) {
1348 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
1349 for (DataSchemaNodeBuilder childNode : parentNode.getChildNodeBuilders()) {
1350 if (childNode.getQName().getLocalName().equals(childName)) {
1351 raiseYangParserException("'" + child + "'", "node", childName, lineNum, childNode.getLine());
1354 parentNode.addChildNode(child);
1355 } else if (parent instanceof ChoiceBuilder) {
1356 ChoiceBuilder parentNode = (ChoiceBuilder) parent;
1357 for (ChoiceCaseBuilder caseBuilder : parentNode.getCases()) {
1358 if (caseBuilder.getQName().getLocalName().equals(childName)) {
1359 raiseYangParserException("'" + child + "'", "node", childName, lineNum, caseBuilder.getLine());
1362 parentNode.addCase(child);
1364 throw new YangParseException(name, lineNum, "Unresolved parent of node '" + childName + "'.");
1368 private ModuleImport createModuleImport(final String moduleName, final Date revision, final String prefix) {
1369 final ModuleImport moduleImport = new ModuleImportImpl(moduleName, revision, prefix);
1370 return moduleImport;
1373 private void raiseYangParserException(final String cantAddType, final String type, final String name,
1374 final int currentLine, final int duplicateLine) {
1376 StringBuilder msgPrefix = new StringBuilder("");
1377 if (cantAddType != null && !cantAddType.isEmpty()) {
1378 msgPrefix.append("Can not add ");
1379 msgPrefix.append(cantAddType);
1380 msgPrefix.append(": ");
1383 String msg = String.format("%s%s with same name '%s' already declared at line %d.", msgPrefix, type, name,
1385 throw new YangParseException(moduleName, currentLine, msg);
1389 public int hashCode() {
1390 final int prime = 31;
1392 result = prime * result + ((name == null) ? 0 : name.hashCode());
1393 result = prime * result + ((namespace == null) ? 0 : namespace.hashCode());
1394 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
1395 result = prime * result + ((prefix == null) ? 0 : prefix.hashCode());
1401 public boolean equals(Object obj) {
1408 if (getClass() != obj.getClass()) {
1411 ModuleBuilder other = (ModuleBuilder) obj;
1413 if (other.name != null) {
1416 } else if (!name.equals(other.name)) {
1419 if (namespace == null) {
1420 if (other.namespace != null) {
1423 } else if (!namespace.equals(other.namespace)) {
1426 if (prefix == null) {
1427 if (other.prefix != null) {
1430 } else if (!prefix.equals(other.prefix)) {
1433 if (revision == null) {
1434 if (other.revision != null) {
1437 } else if (!revision.equals(other.revision)) {