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 Builder getActualParent() {
284 if (actualPath.size() < 2) {
287 Builder builderChild = actualPath.removeFirst();
288 Builder builderParent = actualPath.peekFirst();
289 actualPath.addFirst(builderChild);
290 return builderParent;
294 public Set<TypeAwareBuilder> getDirtyNodes() {
298 public Set<AugmentationSchema> getAugments() {
302 public List<AugmentationSchemaBuilder> getAugmentBuilders() {
303 return augmentBuilders;
306 public List<AugmentationSchemaBuilder> getAllAugments() {
310 public Set<IdentitySchemaNode> getIdentities() {
314 public Set<IdentitySchemaNodeBuilder> getAddedIdentities() {
315 return addedIdentities;
318 public Set<FeatureDefinition> getFeatures() {
322 public Set<FeatureBuilder> getAddedFeatures() {
323 return addedFeatures;
326 public List<GroupingBuilder> getAllGroupings() {
330 public List<UsesNodeBuilder> getAllUsesNodes() {
334 public Set<Deviation> getDeviations() {
338 public Set<DeviationBuilder> getDeviationBuilders() {
339 return deviationBuilders;
342 public List<ExtensionDefinition> getExtensions() {
346 public List<ExtensionBuilder> getAddedExtensions() {
347 return addedExtensions;
350 public List<UnknownSchemaNodeBuilder> getAllUnknownNodes() {
351 return allUnknownNodes;
354 public List<ListSchemaNodeBuilder> getAllLists() {
358 public String getName() {
362 public URI getNamespace() {
366 public void setNamespace(final URI namespace) {
367 this.namespace = namespace;
370 public String getPrefix() {
374 public Date getRevision() {
378 public boolean isSubmodule() {
382 public String getBelongsTo() {
386 public void setBelongsTo(String belongsTo) {
387 this.belongsTo = belongsTo;
390 public void markActualNodeDirty() {
391 final TypeAwareBuilder nodeBuilder = (TypeAwareBuilder) getActualNode();
392 dirtyNodes.add(nodeBuilder);
395 public void setRevision(final Date revision) {
396 this.revision = revision;
399 public void setPrefix(final String prefix) {
400 this.prefix = prefix;
403 public void setYangVersion(final String yangVersion) {
404 instance.setYangVersion(yangVersion);
407 public void setDescription(final String description) {
408 instance.setDescription(description);
411 public void setReference(final String reference) {
412 instance.setReference(reference);
415 public void setOrganization(final String organization) {
416 instance.setOrganization(organization);
419 public void setContact(final String contact) {
420 instance.setContact(contact);
423 public boolean addModuleImport(final String moduleName, final Date revision, final String prefix) {
424 final ModuleImport moduleImport = createModuleImport(moduleName, revision, prefix);
425 return imports.add(moduleImport);
428 public Set<ModuleImport> getModuleImports() {
432 public ExtensionBuilder addExtension(final QName qname, final int line, final SchemaPath path) {
433 Builder parent = getActualNode();
434 if (!(parent.equals(this))) {
435 throw new YangParseException(name, line, "extension can be defined only in module or submodule");
438 final String extName = qname.getLocalName();
439 for (ExtensionBuilder addedExtension : addedExtensions) {
440 if (addedExtension.getQName().getLocalName().equals(extName)) {
441 raiseYangParserException("extension", "node", extName, line, addedExtension.getLine());
444 final ExtensionBuilder builder = new ExtensionBuilder(name, line, qname, path);
445 builder.setParent(parent);
446 addedExtensions.add(builder);
450 public ContainerSchemaNodeBuilder addContainerNode(final int line, final QName qname, final SchemaPath schemaPath) {
451 final ContainerSchemaNodeBuilder builder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
453 Builder parent = getActualNode();
454 builder.setParent(parent);
455 addChildToParent(parent, builder, qname.getLocalName());
460 public ListSchemaNodeBuilder addListNode(final int line, final QName qname, final SchemaPath schemaPath) {
461 final ListSchemaNodeBuilder builder = new ListSchemaNodeBuilder(name, line, qname, schemaPath);
463 Builder parent = getActualNode();
464 builder.setParent(parent);
465 addChildToParent(parent, builder, qname.getLocalName());
466 allLists.add(builder);
471 public LeafSchemaNodeBuilder addLeafNode(final int line, final QName qname, final SchemaPath schemaPath) {
472 final LeafSchemaNodeBuilder builder = new LeafSchemaNodeBuilder(name, line, qname, schemaPath);
474 Builder parent = getActualNode();
475 builder.setParent(parent);
476 addChildToParent(parent, builder, qname.getLocalName());
481 public LeafListSchemaNodeBuilder addLeafListNode(final int line, final QName qname, final SchemaPath schemaPath) {
482 final LeafListSchemaNodeBuilder builder = new LeafListSchemaNodeBuilder(name, line, qname, schemaPath);
484 Builder parent = getActualNode();
485 builder.setParent(parent);
486 addChildToParent(parent, builder, qname.getLocalName());
491 public GroupingBuilder addGrouping(final int line, final QName qname, final SchemaPath path) {
492 final GroupingBuilder builder = new GroupingBuilderImpl(name, line, qname, path);
494 Builder parent = getActualNode();
495 builder.setParent(parent);
497 String groupingName = qname.getLocalName();
498 if (parent.equals(this)) {
499 for (GroupingBuilder addedGrouping : addedGroupings) {
500 if (addedGrouping.getQName().getLocalName().equals(groupingName)) {
501 raiseYangParserException("", "Grouping", groupingName, line, addedGrouping.getLine());
504 addedGroupings.add(builder);
506 if (parent instanceof DataNodeContainerBuilder) {
507 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
508 for (GroupingBuilder addedGrouping : parentNode.getGroupingBuilders()) {
509 if (addedGrouping.getQName().getLocalName().equals(groupingName)) {
510 raiseYangParserException("", "Grouping", groupingName, line, addedGrouping.getLine());
513 parentNode.addGrouping(builder);
514 } else if (parent instanceof RpcDefinitionBuilder) {
515 RpcDefinitionBuilder parentNode = (RpcDefinitionBuilder) parent;
516 for (GroupingBuilder child : parentNode.getGroupings()) {
517 if (child.getQName().getLocalName().equals(groupingName)) {
518 raiseYangParserException("", "Grouping", groupingName, line, child.getLine());
521 parentNode.addGrouping(builder);
523 throw new YangParseException(name, line, "Unresolved parent of grouping " + groupingName);
527 allGroupings.add(builder);
531 public AugmentationSchemaBuilder addAugment(final int line, final String augmentTargetStr) {
532 final AugmentationSchemaBuilder builder = new AugmentationSchemaBuilderImpl(name, line, augmentTargetStr);
534 Builder parent = getActualNode();
535 builder.setParent(parent);
537 if (parent.equals(this)) {
538 // augment can be declared only under 'module' ...
539 if (!(augmentTargetStr.startsWith("/"))) {
540 throw new YangParseException(
543 "If the 'augment' statement is on the top level in a module, the absolute form of a schema node identifier MUST be used.");
545 augmentBuilders.add(builder);
547 // ... or 'uses' statement
548 if (parent instanceof UsesNodeBuilder) {
549 if (augmentTargetStr.startsWith("/")) {
550 throw new YangParseException(name, line,
551 "If 'augment' statement is a substatement to the 'uses' statement, it cannot contain absolute path ("
552 + augmentTargetStr + ")");
554 ((UsesNodeBuilder) parent).addAugment(builder);
556 throw new YangParseException(name, line, "Augment can be declared only under module or uses statement.");
559 allAugments.add(builder);
565 public void addUsesNode(UsesNodeBuilder usesBuilder) {
566 addedUsesNodes.add(usesBuilder);
567 allUsesNodes.add(usesBuilder);
570 public UsesNodeBuilder addUsesNode(final int line, final String groupingPathStr) {
571 final UsesNodeBuilder usesBuilder = new UsesNodeBuilderImpl(name, line, groupingPathStr);
573 Builder parent = getActualNode();
574 usesBuilder.setParent(parent);
576 if (parent.equals(this)) {
577 addedUsesNodes.add(usesBuilder);
579 if (!(parent instanceof DataNodeContainerBuilder)) {
580 throw new YangParseException(name, line, "Unresolved parent of uses '" + groupingPathStr + "'.");
582 ((DataNodeContainerBuilder) parent).addUsesNode(usesBuilder);
584 if (parent instanceof AugmentationSchemaBuilder) {
585 usesBuilder.setAugmenting(true);
588 allUsesNodes.add(usesBuilder);
592 public void addRefine(final RefineHolder refine) {
593 final Builder parent = getActualNode();
594 if (!(parent instanceof UsesNodeBuilder)) {
595 throw new YangParseException(name, refine.getLine(), "refine can be defined only in uses statement");
597 ((UsesNodeBuilder) parent).addRefine(refine);
598 refine.setParent(parent);
601 public RpcDefinitionBuilder addRpc(final int line, final QName qname, final SchemaPath path) {
602 Builder parent = getActualNode();
603 if (!(parent.equals(this))) {
604 throw new YangParseException(name, line, "rpc can be defined only in module or submodule");
607 final RpcDefinitionBuilder rpcBuilder = new RpcDefinitionBuilder(name, line, qname, path);
608 rpcBuilder.setParent(parent);
610 String rpcName = qname.getLocalName();
611 for (RpcDefinitionBuilder rpc : addedRpcs) {
612 if (rpc.getQName().getLocalName().equals(rpcName)) {
613 raiseYangParserException("", "rpc", rpcName, line, rpc.getLine());
616 for (DataSchemaNodeBuilder addedChild : addedChildNodes) {
617 if (addedChild.getQName().getLocalName().equals(rpcName)) {
618 raiseYangParserException("rpc", "node", rpcName, line, addedChild.getLine());
621 for (NotificationBuilder addedNotification : addedNotifications) {
622 if (addedNotification.getQName().getLocalName().equals(rpcName)) {
623 raiseYangParserException("rpc", "notification", rpcName, line, addedNotification.getLine());
626 addedRpcs.add(rpcBuilder);
630 public ContainerSchemaNodeBuilder addRpcInput(final int line, final QName qname, final SchemaPath schemaPath) {
631 final Builder parent = getActualNode();
632 if (!(parent instanceof RpcDefinitionBuilder)) {
633 throw new YangParseException(name, line, "input can be defined only in rpc statement");
635 final RpcDefinitionBuilder rpc = (RpcDefinitionBuilder) parent;
637 final ContainerSchemaNodeBuilder inputBuilder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
638 inputBuilder.setParent(rpc);
640 rpc.setInput(inputBuilder);
644 public ContainerSchemaNodeBuilder addRpcOutput(final SchemaPath schemaPath, final QName qname, final int line) {
645 final Builder parent = getActualNode();
646 if (!(parent instanceof RpcDefinitionBuilder)) {
647 throw new YangParseException(name, line, "output can be defined only in rpc statement");
649 final RpcDefinitionBuilder rpc = (RpcDefinitionBuilder) parent;
651 final ContainerSchemaNodeBuilder outputBuilder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
652 outputBuilder.setParent(rpc);
654 rpc.setOutput(outputBuilder);
655 return outputBuilder;
658 public void addNotification(NotificationDefinition notification) {
659 notifications.add(notification);
662 public NotificationBuilder addNotification(final int line, final QName qname, final SchemaPath path) {
663 final Builder parent = getActualNode();
664 if (!(parent.equals(this))) {
665 throw new YangParseException(name, line, "notification can be defined only in module or submodule");
668 String notificationName = qname.getLocalName();
669 for (NotificationBuilder nb : addedNotifications) {
670 if (nb.getQName().equals(qname)) {
671 raiseYangParserException("", "notification", notificationName, line, nb.getLine());
674 for (RpcDefinitionBuilder rpc : addedRpcs) {
675 if (rpc.getQName().getLocalName().equals(notificationName)) {
676 raiseYangParserException("notification", "rpc", notificationName, line, rpc.getLine());
679 for (DataSchemaNodeBuilder addedChild : addedChildNodes) {
680 if (addedChild.getQName().getLocalName().equals(notificationName)) {
681 raiseYangParserException("notification", "node", notificationName, line, addedChild.getLine());
685 final NotificationBuilder builder = new NotificationBuilder(name, line, qname, path);
686 builder.setParent(parent);
687 addedNotifications.add(builder);
692 public FeatureBuilder addFeature(final int line, final QName qname, final SchemaPath path) {
693 Builder parent = getActualNode();
694 if (!(parent.equals(this))) {
695 throw new YangParseException(name, line, "feature can be defined only in module or submodule");
698 final FeatureBuilder builder = new FeatureBuilder(name, line, qname, path);
699 builder.setParent(parent);
701 String featureName = qname.getLocalName();
702 for (FeatureBuilder addedFeature : addedFeatures) {
703 if (addedFeature.getQName().getLocalName().equals(featureName)) {
704 raiseYangParserException("", "feature", featureName, line, addedFeature.getLine());
707 addedFeatures.add(builder);
711 public ChoiceBuilder addChoice(final int line, final QName qname, final SchemaPath path) {
712 final ChoiceBuilder builder = new ChoiceBuilder(name, line, qname, path);
714 Builder parent = getActualNode();
715 builder.setParent(parent);
716 addChildToParent(parent, builder, qname.getLocalName());
721 public ChoiceCaseBuilder addCase(final int line, final QName qname, final SchemaPath path) {
722 Builder parent = getActualNode();
723 if (parent == null || parent.equals(this)) {
724 throw new YangParseException(name, line, "'case' parent not found");
727 final ChoiceCaseBuilder builder = new ChoiceCaseBuilder(name, line, qname, path);
728 builder.setParent(parent);
730 if (parent instanceof ChoiceBuilder) {
731 ((ChoiceBuilder) parent).addCase(builder);
732 } else if (parent instanceof AugmentationSchemaBuilder) {
733 ((AugmentationSchemaBuilder) parent).addChildNode(builder);
735 throw new YangParseException(name, line, "Unresolved parent of 'case' " + qname.getLocalName());
741 public AnyXmlBuilder addAnyXml(final int line, final QName qname, final SchemaPath schemaPath) {
742 final AnyXmlBuilder builder = new AnyXmlBuilder(name, line, qname, schemaPath);
744 Builder parent = getActualNode();
745 builder.setParent(parent);
746 addChildToParent(parent, builder, qname.getLocalName());
752 public void addTypedef(TypeDefinitionBuilder typedefBuilder) {
753 String nodeName = typedefBuilder.getQName().getLocalName();
754 for (TypeDefinitionBuilder tdb : addedTypedefs) {
755 if (tdb.getQName().getLocalName().equals(nodeName)) {
756 raiseYangParserException("", "typedef", nodeName, typedefBuilder.getLine(), tdb.getLine());
759 addedTypedefs.add(typedefBuilder);
762 public TypeDefinitionBuilderImpl addTypedef(final int line, final QName qname, final SchemaPath path) {
763 final TypeDefinitionBuilderImpl builder = new TypeDefinitionBuilderImpl(name, line, qname, path);
765 Builder parent = getActualNode();
766 builder.setParent(parent);
768 String typedefName = qname.getLocalName();
769 if (parent.equals(this)) {
770 for (TypeDefinitionBuilder tdb : addedTypedefs) {
771 if (tdb.getQName().getLocalName().equals(typedefName)) {
772 raiseYangParserException("", "typedef", typedefName, line, tdb.getLine());
775 addedTypedefs.add(builder);
777 if (parent instanceof DataNodeContainerBuilder) {
778 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
779 for (TypeDefinitionBuilder child : parentNode.getTypeDefinitionBuilders()) {
780 if (child.getQName().getLocalName().equals(typedefName)) {
781 raiseYangParserException("", "typedef", typedefName, line, child.getLine());
784 parentNode.addTypedef(builder);
785 } else if (parent instanceof RpcDefinitionBuilder) {
786 RpcDefinitionBuilder rpcParent = (RpcDefinitionBuilder) parent;
787 for (TypeDefinitionBuilder tdb : rpcParent.getTypeDefinitions()) {
788 if (tdb.getQName().getLocalName().equals(builder.getQName().getLocalName())) {
789 raiseYangParserException("", "typedef", typedefName, line, tdb.getLine());
792 rpcParent.addTypedef(builder);
794 throw new YangParseException(name, line, "Unresolved parent of typedef " + typedefName);
801 public void setType(final TypeDefinition<?> type) {
802 Builder parent = getActualNode();
803 if (!(parent instanceof TypeAwareBuilder)) {
804 throw new YangParseException("Failed to set type '" + type.getQName().getLocalName()
805 + "'. Invalid parent node: " + parent);
807 ((TypeAwareBuilder) parent).setType(type);
810 public UnionTypeBuilder addUnionType(final int line, final URI namespace, final Date revision) {
811 final Builder parent = getActualNode();
812 if (parent == null) {
813 throw new YangParseException(name, line, "Unresolved parent of union type");
815 final UnionTypeBuilder union = new UnionTypeBuilder(name, line);
816 if (parent instanceof TypeAwareBuilder) {
817 ((TypeAwareBuilder) parent).setTypedef(union);
820 throw new YangParseException(name, line, "Invalid parent of union type.");
825 public void addIdentityrefType(final int line, final SchemaPath schemaPath, final String baseString) {
826 final IdentityrefTypeBuilder identityref = new IdentityrefTypeBuilder(name, line, baseString, schemaPath);
828 final Builder parent = getActualNode();
829 if (parent == null) {
830 throw new YangParseException(name, line, "Unresolved parent of identityref type.");
832 if (parent instanceof TypeAwareBuilder) {
833 final TypeAwareBuilder typeParent = (TypeAwareBuilder) parent;
834 typeParent.setTypedef(identityref);
835 dirtyNodes.add(typeParent);
837 throw new YangParseException(name, line, "Invalid parent of identityref type.");
842 public DeviationBuilder addDeviation(final int line, final String targetPath) {
843 Builder parent = getActualNode();
844 if (!(parent.equals(this))) {
845 throw new YangParseException(name, line, "deviation can be defined only in module or submodule");
848 final DeviationBuilder builder = new DeviationBuilder(name, line, targetPath);
849 builder.setParent(parent);
850 deviationBuilders.add(builder);
854 public IdentitySchemaNodeBuilder addIdentity(final QName qname, final int line, final SchemaPath path) {
855 Builder parent = getActualNode();
856 if (!(parent.equals(this))) {
857 throw new YangParseException(name, line, "identity can be defined only in module or submodule");
859 String identityName = qname.getLocalName();
860 for (IdentitySchemaNodeBuilder idBuilder : addedIdentities) {
861 if (idBuilder.getQName().equals(qname)) {
862 raiseYangParserException("", "identity", identityName, line, idBuilder.getLine());
866 final IdentitySchemaNodeBuilder builder = new IdentitySchemaNodeBuilder(name, line, qname, path);
867 builder.setParent(parent);
868 addedIdentities.add(builder);
873 public void addUnknownNodeBuilder(final UnknownSchemaNodeBuilder builder) {
874 addedUnknownNodes.add(builder);
875 allUnknownNodes.add(builder);
878 public UnknownSchemaNodeBuilder addUnknownSchemaNode(final int line, final QName qname, final SchemaPath path) {
879 final Builder parent = getActualNode();
880 final UnknownSchemaNodeBuilder builder = new UnknownSchemaNodeBuilder(name, line, qname, path);
881 builder.setParent(parent);
882 allUnknownNodes.add(builder);
884 if (parent.equals(this)) {
885 addedUnknownNodes.add(builder);
887 if (parent instanceof SchemaNodeBuilder) {
888 ((SchemaNodeBuilder) parent).addUnknownNodeBuilder(builder);
889 } else if (parent instanceof DataNodeContainerBuilder) {
890 ((DataNodeContainerBuilder) parent).addUnknownNodeBuilder(builder);
891 } else if (parent instanceof RefineHolder) {
892 ((RefineHolder) parent).addUnknownNodeBuilder(builder);
894 throw new YangParseException(name, line, "Unresolved parent of unknown node '" + qname.getLocalName()
902 public Set<RpcDefinition> getRpcs() {
906 public Set<RpcDefinitionBuilder> getAddedRpcs() {
910 public Set<NotificationDefinition> getNotifications() {
911 return notifications;
914 public Set<NotificationBuilder> getAddedNotifications() {
915 return addedNotifications;
919 public String toString() {
920 return "module " + name;
923 public void setSource(String source) {
924 this.source = source;
927 public static final class ModuleImpl implements Module {
928 private URI namespace;
929 private final String name;
930 private final String sourcePath;
931 private Date revision;
932 private String prefix;
933 private String yangVersion;
934 private String description;
935 private String reference;
936 private String organization;
937 private String contact;
938 private final Set<ModuleImport> imports = new HashSet<>();
939 private final Set<FeatureDefinition> features = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
940 private final Set<TypeDefinition<?>> typeDefinitions = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
941 private final Set<NotificationDefinition> notifications = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
942 private final Set<AugmentationSchema> augmentations = new HashSet<>();
943 private final Set<RpcDefinition> rpcs = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
944 private final Set<Deviation> deviations = new HashSet<>();
945 private final Set<DataSchemaNode> childNodes = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
946 private final Set<GroupingDefinition> groupings = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
947 private final Set<UsesNode> uses = new HashSet<>();
948 private final List<ExtensionDefinition> extensionNodes = new ArrayList<>();
949 private final Set<IdentitySchemaNode> identities = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
950 private final List<UnknownSchemaNode> unknownNodes = new ArrayList<>();
951 private String source;
953 private ModuleImpl(String name, String sourcePath) {
955 this.sourcePath = sourcePath;
959 public String getModuleSourcePath() {
964 public URI getNamespace() {
968 private void setNamespace(URI namespace) {
969 this.namespace = namespace;
973 public String getName() {
978 public Date getRevision() {
982 private void setRevision(Date revision) {
983 this.revision = revision;
987 public String getPrefix() {
991 private void setPrefix(String prefix) {
992 this.prefix = prefix;
996 public String getYangVersion() {
1000 private void setYangVersion(String yangVersion) {
1001 this.yangVersion = yangVersion;
1005 public String getDescription() {
1009 private void setDescription(String description) {
1010 this.description = description;
1014 public String getReference() {
1018 private void setReference(String reference) {
1019 this.reference = reference;
1023 public String getOrganization() {
1024 return organization;
1027 private void setOrganization(String organization) {
1028 this.organization = organization;
1032 public String getContact() {
1036 private void setContact(String contact) {
1037 this.contact = contact;
1041 public Set<ModuleImport> getImports() {
1045 private void setImports(Set<ModuleImport> imports) {
1046 if (imports != null) {
1047 this.imports.addAll(imports);
1052 public Set<FeatureDefinition> getFeatures() {
1056 private void setFeatures(Set<FeatureDefinition> features) {
1057 if (features != null) {
1058 this.features.addAll(features);
1063 public Set<TypeDefinition<?>> getTypeDefinitions() {
1064 return typeDefinitions;
1067 private void setTypeDefinitions(Set<TypeDefinition<?>> typeDefinitions) {
1068 if (typeDefinitions != null) {
1069 this.typeDefinitions.addAll(typeDefinitions);
1074 public Set<NotificationDefinition> getNotifications() {
1075 return notifications;
1078 private void setNotifications(Set<NotificationDefinition> notifications) {
1079 if (notifications != null) {
1080 this.notifications.addAll(notifications);
1085 public Set<AugmentationSchema> getAugmentations() {
1086 return augmentations;
1089 private void setAugmentations(Set<AugmentationSchema> augmentations) {
1090 if (augmentations != null) {
1091 this.augmentations.addAll(augmentations);
1096 public Set<RpcDefinition> getRpcs() {
1100 private void setRpcs(Set<RpcDefinition> rpcs) {
1102 this.rpcs.addAll(rpcs);
1107 public Set<Deviation> getDeviations() {
1111 private void setDeviations(Set<Deviation> deviations) {
1112 if (deviations != null) {
1113 this.deviations.addAll(deviations);
1118 public Set<DataSchemaNode> getChildNodes() {
1119 return Collections.unmodifiableSet(childNodes);
1122 private void addChildNodes(Set<DataSchemaNode> childNodes) {
1123 if (childNodes != null) {
1124 this.childNodes.addAll(childNodes);
1129 public Set<GroupingDefinition> getGroupings() {
1133 private void setGroupings(Set<GroupingDefinition> groupings) {
1134 if (groupings != null) {
1135 this.groupings.addAll(groupings);
1140 public Set<UsesNode> getUses() {
1144 private void setUses(Set<UsesNode> uses) {
1146 this.uses.addAll(uses);
1151 public List<ExtensionDefinition> getExtensionSchemaNodes() {
1152 Collections.sort(extensionNodes, Comparators.SCHEMA_NODE_COMP);
1153 return extensionNodes;
1156 private void setExtensionSchemaNodes(final List<ExtensionDefinition> extensionNodes) {
1157 if (extensionNodes != null) {
1158 this.extensionNodes.addAll(extensionNodes);
1163 public Set<IdentitySchemaNode> getIdentities() {
1167 private void setIdentities(final Set<IdentitySchemaNode> identities) {
1168 if (identities != null) {
1169 this.identities.addAll(identities);
1174 public List<UnknownSchemaNode> getUnknownSchemaNodes() {
1175 return unknownNodes;
1178 private void setUnknownSchemaNodes(final List<UnknownSchemaNode> unknownNodes) {
1179 if (unknownNodes != null) {
1180 this.unknownNodes.addAll(unknownNodes);
1185 public DataSchemaNode getDataChildByName(QName name) {
1186 return getChildNode(childNodes, name);
1190 public DataSchemaNode getDataChildByName(String name) {
1191 return getChildNode(childNodes, name);
1194 void setSource(String source){
1195 this.source = source;
1198 public String getSource() {
1202 // FIXME: prefix should not be taken into consideration, perhaps namespace too
1204 public int hashCode() {
1205 final int prime = 31;
1207 result = prime * result + ((namespace == null) ? 0 : namespace.hashCode());
1208 result = prime * result + ((name == null) ? 0 : name.hashCode());
1209 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
1210 result = prime * result + ((prefix == null) ? 0 : prefix.hashCode());
1211 result = prime * result + ((yangVersion == null) ? 0 : yangVersion.hashCode());
1216 public boolean equals(Object obj) {
1223 if (getClass() != obj.getClass()) {
1226 ModuleImpl other = (ModuleImpl) obj;
1227 if (namespace == null) {
1228 if (other.namespace != null) {
1231 } else if (!namespace.equals(other.namespace)) {
1235 if (other.name != null) {
1238 } else if (!name.equals(other.name)) {
1241 if (revision == null) {
1242 if (other.revision != null) {
1245 } else if (!revision.equals(other.revision)) {
1248 if (prefix == null) {
1249 if (other.prefix != null) {
1252 } else if (!prefix.equals(other.prefix)) {
1255 if (yangVersion == null) {
1256 if (other.yangVersion != null) {
1259 } else if (!yangVersion.equals(other.yangVersion)) {
1266 public String toString() {
1267 StringBuilder sb = new StringBuilder(ModuleImpl.class.getSimpleName());
1269 sb.append("name=" + name);
1270 sb.append(", namespace=" + namespace);
1271 sb.append(", revision=" + revision);
1272 sb.append(", prefix=" + prefix);
1273 sb.append(", yangVersion=" + yangVersion);
1275 return sb.toString();
1280 * Add child to parent. Method checks for duplicates and add given child
1281 * node to parent. If node with same name is found, throws exception. If
1282 * parent is null, child node will be added directly to module.
1288 private void addChildToParent(final Builder parent, final DataSchemaNodeBuilder child, final String childName) {
1289 final int lineNum = child.getLine();
1290 if (parent.equals(this)) {
1291 addChildToModule(child, childName, lineNum);
1293 addChildToSubnodeOfModule(parent, child, childName, lineNum);
1298 * Adds child node <code>child</code> to the set of nodes child nodes.
1300 * The method reduces the complexity of the method
1301 * {@link #addChildToParent(Builder, DataSchemaNodeBuilder, String)
1302 * addChildToParent}.
1305 * data schema node builder for child node
1307 * string with name of child node
1309 * line number in YANG file where is the node with the name equal
1310 * to <code>childName</code> is defined
1312 private void addChildToModule(final DataSchemaNodeBuilder child, final String childName, final int lineNum) {
1313 // if parent == null => node is defined under module
1314 // All leafs, leaf-lists, lists, containers, choices, rpcs,
1315 // notifications, and anyxmls defined within a parent node or at the
1316 // top level of the module or its submodules share the same
1317 // identifier namespace.
1318 for (DataSchemaNodeBuilder childNode : addedChildNodes) {
1319 if (childNode.getQName().getLocalName().equals(childName)) {
1320 raiseYangParserException("'" + child + "'", "node", childName, lineNum, childNode.getLine());
1323 for (RpcDefinitionBuilder rpc : addedRpcs) {
1324 if (rpc.getQName().getLocalName().equals(childName)) {
1325 raiseYangParserException("'" + child + "'", "rpc", childName, lineNum, rpc.getLine());
1328 for (NotificationBuilder notification : addedNotifications) {
1329 if (notification.getQName().getLocalName().equals(childName)) {
1330 raiseYangParserException("'" + child + "'", "notification", childName, lineNum, notification.getLine());
1333 addedChildNodes.add(child);
1337 * Adds child node <code>child</code> to the group of child nodes of the
1338 * <code>parent</code>
1340 * The method reduces the complexity of the method
1341 * {@link #addChildToParent(Builder, DataSchemaNodeBuilder, String)
1342 * addChildToParent}. *
1345 * builder of node which is parent for <code>child</code>
1347 * data schema node builder for child node
1349 * string with name of child node
1351 * line number in YANG file where is the node with the name equal
1352 * to <code>childName</code> is defined
1354 private void addChildToSubnodeOfModule(final Builder parent, final DataSchemaNodeBuilder child,
1355 final String childName, final int lineNum) {
1356 // no need for checking rpc and notification because they can be
1357 // defined only under module or submodule
1358 if (parent instanceof DataNodeContainerBuilder) {
1359 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
1360 for (DataSchemaNodeBuilder childNode : parentNode.getChildNodeBuilders()) {
1361 if (childNode.getQName().getLocalName().equals(childName)) {
1362 raiseYangParserException("'" + child + "'", "node", childName, lineNum, childNode.getLine());
1365 parentNode.addChildNode(child);
1366 } else if (parent instanceof ChoiceBuilder) {
1367 ChoiceBuilder parentNode = (ChoiceBuilder) parent;
1368 for (ChoiceCaseBuilder caseBuilder : parentNode.getCases()) {
1369 if (caseBuilder.getQName().getLocalName().equals(childName)) {
1370 raiseYangParserException("'" + child + "'", "node", childName, lineNum, caseBuilder.getLine());
1373 parentNode.addCase(child);
1375 throw new YangParseException(name, lineNum, "Unresolved parent of node '" + childName + "'.");
1379 private ModuleImport createModuleImport(final String moduleName, final Date revision, final String prefix) {
1380 final ModuleImport moduleImport = new ModuleImportImpl(moduleName, revision, prefix);
1381 return moduleImport;
1384 private void raiseYangParserException(final String cantAddType, final String type, final String name,
1385 final int currentLine, final int duplicateLine) {
1387 StringBuilder msgPrefix = new StringBuilder("");
1388 if (cantAddType != null && !cantAddType.isEmpty()) {
1389 msgPrefix.append("Can not add ");
1390 msgPrefix.append(cantAddType);
1391 msgPrefix.append(": ");
1394 String msg = String.format("%s%s with same name '%s' already declared at line %d.", msgPrefix, type, name,
1396 throw new YangParseException(moduleName, currentLine, msg);
1400 public int hashCode() {
1401 final int prime = 31;
1403 result = prime * result + ((name == null) ? 0 : name.hashCode());
1404 result = prime * result + ((namespace == null) ? 0 : namespace.hashCode());
1405 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
1406 result = prime * result + ((prefix == null) ? 0 : prefix.hashCode());
1412 public boolean equals(Object obj) {
1419 if (getClass() != obj.getClass()) {
1422 ModuleBuilder other = (ModuleBuilder) obj;
1424 if (other.name != null) {
1427 } else if (!name.equals(other.name)) {
1430 if (namespace == null) {
1431 if (other.namespace != null) {
1434 } else if (!namespace.equals(other.namespace)) {
1437 if (prefix == null) {
1438 if (other.prefix != null) {
1441 } else if (!prefix.equals(other.prefix)) {
1444 if (revision == null) {
1445 if (other.revision != null) {
1448 } else if (!revision.equals(other.revision)) {