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;
11 import java.util.ArrayList;
12 import java.util.Collections;
13 import java.util.Date;
14 import java.util.Deque;
15 import java.util.HashSet;
16 import java.util.LinkedList;
17 import java.util.List;
19 import java.util.TreeSet;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
22 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.Deviation;
24 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
25 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
26 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
27 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.Module;
29 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
30 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
31 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
32 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
33 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
34 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.UsesNode;
36 import org.opendaylight.yangtools.yang.parser.builder.api.AbstractDataNodeContainerBuilder;
37 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
38 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
39 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
40 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
41 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
42 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
43 import org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder;
44 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
45 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
46 import org.opendaylight.yangtools.yang.parser.util.Comparators;
47 import org.opendaylight.yangtools.yang.parser.util.ModuleImportImpl;
48 import org.opendaylight.yangtools.yang.parser.util.RefineHolder;
49 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
52 * Builder of Module object. If this module is dependent on external
53 * module/modules, these dependencies must be resolved before module is built,
54 * otherwise result may not be valid.
56 public class ModuleBuilder extends AbstractDataNodeContainerBuilder {
58 private final ModuleImpl instance;
59 private final String name;
60 private final String sourcePath;
61 private final SchemaPath schemaPath;
62 private URI namespace;
63 private String prefix;
64 private Date revision;
66 private final boolean submodule;
67 private String belongsTo;
68 private ModuleBuilder parent;
70 public ModuleBuilder getParent() {
74 public void setParent(ModuleBuilder parent) {
78 private final Deque<Builder> actualPath = new LinkedList<>();
79 private final Set<TypeAwareBuilder> dirtyNodes = new HashSet<>();
81 private final Set<ModuleImport> imports = new HashSet<ModuleImport>();
83 private final Set<AugmentationSchema> augments = new HashSet<>();
84 private final List<AugmentationSchemaBuilder> augmentBuilders = new ArrayList<>();
85 private final List<AugmentationSchemaBuilder> allAugments = new ArrayList<>();
87 private final List<GroupingBuilder> allGroupings = new ArrayList<>();
89 private final List<UsesNodeBuilder> allUsesNodes = new ArrayList<>();
91 private final Set<RpcDefinition> rpcs = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
92 private final Set<RpcDefinitionBuilder> addedRpcs = new HashSet<>();
94 private final Set<NotificationDefinition> notifications = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
95 private final Set<NotificationBuilder> addedNotifications = new HashSet<>();
97 private final Set<IdentitySchemaNode> identities = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
98 private final Set<IdentitySchemaNodeBuilder> addedIdentities = new HashSet<>();
100 private final Set<FeatureDefinition> features = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
101 private final Set<FeatureBuilder> addedFeatures = new HashSet<>();
103 private final Set<Deviation> deviations = new HashSet<>();
104 private final Set<DeviationBuilder> deviationBuilders = new HashSet<>();
106 private final List<ExtensionDefinition> extensions = new ArrayList<>();
107 private final List<ExtensionBuilder> addedExtensions = new ArrayList<>();
109 private final List<UnknownSchemaNodeBuilder> allUnknownNodes = new ArrayList<UnknownSchemaNodeBuilder>();
111 private final List<ListSchemaNodeBuilder> allLists = new ArrayList<ListSchemaNodeBuilder>();
113 private String source;
115 public ModuleBuilder(final String name, final String sourcePath) {
116 this(name, false, sourcePath);
119 public ModuleBuilder(final String name, final boolean submodule, final String sourcePath) {
120 super(name, 0, null);
122 this.sourcePath = sourcePath;
123 schemaPath = new SchemaPath(Collections.<QName> emptyList(), true);
124 this.submodule = submodule;
125 instance = new ModuleImpl(name, sourcePath);
126 actualPath.push(this);
129 public ModuleBuilder(Module base) {
130 super(base.getName(), 0, null);
131 this.name = base.getName();
132 this.sourcePath = base.getModuleSourcePath();
133 schemaPath = new SchemaPath(Collections.<QName> emptyList(), true);
135 instance = new ModuleImpl(base.getName(), base.getModuleSourcePath());
136 instance.setYangVersion(base.getYangVersion());
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());
153 for (IdentitySchemaNode identityNode : base.getIdentities()) {
154 addedIdentities.add(new IdentitySchemaNodeBuilder(name, identityNode));
157 features.addAll(base.getFeatures());
158 deviations.addAll(base.getDeviations());
159 extensions.addAll(base.getExtensionSchemaNodes());
160 unknownNodes.addAll(base.getUnknownSchemaNodes());
164 * Build new Module object based on this builder.
167 public Module build() {
168 instance.setPrefix(prefix);
169 instance.setRevision(revision);
170 instance.setImports(imports);
171 instance.setNamespace(namespace);
174 for (TypeDefinitionBuilder tdb : addedTypedefs) {
175 typedefs.add(tdb.build());
177 instance.setTypeDefinitions(typedefs);
180 for (DataSchemaNodeBuilder child : addedChildNodes) {
181 childNodes.add(child.build());
183 instance.addChildNodes(childNodes);
186 for (GroupingBuilder gb : addedGroupings) {
187 groupings.add(gb.build());
189 instance.setGroupings(groupings);
192 for (UsesNodeBuilder unb : addedUsesNodes) {
193 usesNodes.add(unb.build());
195 instance.setUses(usesNodes);
198 for (FeatureBuilder fb : addedFeatures) {
199 features.add(fb.build());
201 instance.setFeatures(features);
204 for (NotificationBuilder entry : addedNotifications) {
205 notifications.add(entry.build());
207 instance.setNotifications(notifications);
210 for (AugmentationSchemaBuilder builder : augmentBuilders) {
211 augments.add(builder.build());
213 instance.setAugmentations(augments);
216 for (RpcDefinitionBuilder rpc : addedRpcs) {
217 rpcs.add(rpc.build());
219 instance.setRpcs(rpcs);
222 for (DeviationBuilder entry : deviationBuilders) {
223 deviations.add(entry.build());
225 instance.setDeviations(deviations);
228 for (ExtensionBuilder eb : addedExtensions) {
229 extensions.add(eb.build());
231 Collections.sort(extensions, Comparators.SCHEMA_NODE_COMP);
232 instance.setExtensionSchemaNodes(extensions);
235 for (IdentitySchemaNodeBuilder id : addedIdentities) {
236 identities.add(id.build());
238 instance.setIdentities(identities);
241 for (UnknownSchemaNodeBuilder unb : addedUnknownNodes) {
242 unknownNodes.add(unb.build());
244 Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
245 instance.setUnknownSchemaNodes(unknownNodes);
247 instance.setSource(source);
252 public String getModuleSourcePath() {
257 public void setParent(Builder parent) {
258 throw new YangParseException(name, 0, "Can not set parent to module");
262 public SchemaPath getPath() {
267 public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
268 return addedTypedefs;
271 public void enterNode(final Builder node) {
272 actualPath.push(node);
275 public void exitNode() {
279 public Builder getActualNode() {
280 if (actualPath.isEmpty()) {
283 return actualPath.peekFirst();
287 public Set<TypeAwareBuilder> getDirtyNodes() {
291 public Set<AugmentationSchema> getAugments() {
295 public List<AugmentationSchemaBuilder> getAugmentBuilders() {
296 return augmentBuilders;
299 public List<AugmentationSchemaBuilder> getAllAugments() {
303 public Set<IdentitySchemaNode> getIdentities() {
307 public Set<IdentitySchemaNodeBuilder> getAddedIdentities() {
308 return addedIdentities;
311 public Set<FeatureDefinition> getFeatures() {
315 public Set<FeatureBuilder> getAddedFeatures() {
316 return addedFeatures;
319 public List<GroupingBuilder> getAllGroupings() {
323 public List<UsesNodeBuilder> getAllUsesNodes() {
327 public Set<Deviation> getDeviations() {
331 public Set<DeviationBuilder> getDeviationBuilders() {
332 return deviationBuilders;
335 public List<ExtensionDefinition> getExtensions() {
339 public List<ExtensionBuilder> getAddedExtensions() {
340 return addedExtensions;
343 public List<UnknownSchemaNodeBuilder> getAllUnknownNodes() {
344 return allUnknownNodes;
347 public List<ListSchemaNodeBuilder> getAllLists() {
351 public String getName() {
355 public URI getNamespace() {
359 public void setNamespace(final URI namespace) {
360 this.namespace = namespace;
363 public String getPrefix() {
367 public Date getRevision() {
371 public boolean isSubmodule() {
375 public String getBelongsTo() {
379 public void setBelongsTo(String belongsTo) {
380 this.belongsTo = belongsTo;
383 public void markActualNodeDirty() {
384 final TypeAwareBuilder nodeBuilder = (TypeAwareBuilder) getActualNode();
385 dirtyNodes.add(nodeBuilder);
388 public void setRevision(final Date revision) {
389 this.revision = revision;
392 public void setPrefix(final String prefix) {
393 this.prefix = prefix;
396 public void setYangVersion(final String yangVersion) {
397 instance.setYangVersion(yangVersion);
400 public void setDescription(final String description) {
401 instance.setDescription(description);
404 public void setReference(final String reference) {
405 instance.setReference(reference);
408 public void setOrganization(final String organization) {
409 instance.setOrganization(organization);
412 public void setContact(final String contact) {
413 instance.setContact(contact);
416 public boolean addModuleImport(final String moduleName, final Date revision, final String prefix) {
417 final ModuleImport moduleImport = createModuleImport(moduleName, revision, prefix);
418 return imports.add(moduleImport);
421 public Set<ModuleImport> getModuleImports() {
425 public ExtensionBuilder addExtension(final QName qname, final int line, final SchemaPath path) {
426 Builder parent = getActualNode();
427 if (!(parent.equals(this))) {
428 throw new YangParseException(name, line, "extension can be defined only in module or submodule");
431 final String extName = qname.getLocalName();
432 for (ExtensionBuilder addedExtension : addedExtensions) {
433 if (addedExtension.getQName().getLocalName().equals(extName)) {
434 raiseYangParserException("extension", "node", extName, line, addedExtension.getLine());
437 final ExtensionBuilder builder = new ExtensionBuilder(name, line, qname, path);
438 builder.setParent(parent);
439 addedExtensions.add(builder);
443 public ContainerSchemaNodeBuilder addContainerNode(final int line, final QName qname, final SchemaPath schemaPath) {
444 final ContainerSchemaNodeBuilder builder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
446 Builder parent = getActualNode();
447 builder.setParent(parent);
448 addChildToParent(parent, builder, qname.getLocalName());
453 public ListSchemaNodeBuilder addListNode(final int line, final QName qname, final SchemaPath schemaPath) {
454 final ListSchemaNodeBuilder builder = new ListSchemaNodeBuilder(name, line, qname, schemaPath);
456 Builder parent = getActualNode();
457 builder.setParent(parent);
458 addChildToParent(parent, builder, qname.getLocalName());
459 allLists.add(builder);
464 public LeafSchemaNodeBuilder addLeafNode(final int line, final QName qname, final SchemaPath schemaPath) {
465 final LeafSchemaNodeBuilder builder = new LeafSchemaNodeBuilder(name, line, qname, schemaPath);
467 Builder parent = getActualNode();
468 builder.setParent(parent);
469 addChildToParent(parent, builder, qname.getLocalName());
474 public LeafListSchemaNodeBuilder addLeafListNode(final int line, final QName qname, final SchemaPath schemaPath) {
475 final LeafListSchemaNodeBuilder builder = new LeafListSchemaNodeBuilder(name, line, qname, schemaPath);
477 Builder parent = getActualNode();
478 builder.setParent(parent);
479 addChildToParent(parent, builder, qname.getLocalName());
484 public GroupingBuilder addGrouping(final int line, final QName qname, final SchemaPath path) {
485 final GroupingBuilder builder = new GroupingBuilderImpl(name, line, qname, path);
487 Builder parent = getActualNode();
488 builder.setParent(parent);
490 String groupingName = qname.getLocalName();
491 if (parent.equals(this)) {
492 for (GroupingBuilder addedGrouping : addedGroupings) {
493 if (addedGrouping.getQName().getLocalName().equals(groupingName)) {
494 raiseYangParserException("", "Grouping", groupingName, line, addedGrouping.getLine());
497 addedGroupings.add(builder);
499 if (parent instanceof DataNodeContainerBuilder) {
500 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
501 for (GroupingBuilder addedGrouping : parentNode.getGroupingBuilders()) {
502 if (addedGrouping.getQName().getLocalName().equals(groupingName)) {
503 raiseYangParserException("", "Grouping", groupingName, line, addedGrouping.getLine());
506 parentNode.addGrouping(builder);
507 } else if (parent instanceof RpcDefinitionBuilder) {
508 RpcDefinitionBuilder parentNode = (RpcDefinitionBuilder) parent;
509 for (GroupingBuilder child : parentNode.getGroupings()) {
510 if (child.getQName().getLocalName().equals(groupingName)) {
511 raiseYangParserException("", "Grouping", groupingName, line, child.getLine());
514 parentNode.addGrouping(builder);
516 throw new YangParseException(name, line, "Unresolved parent of grouping " + groupingName);
520 allGroupings.add(builder);
524 public AugmentationSchemaBuilder addAugment(final int line, final String augmentTargetStr) {
525 final AugmentationSchemaBuilder builder = new AugmentationSchemaBuilderImpl(name, line, augmentTargetStr);
527 Builder parent = getActualNode();
528 builder.setParent(parent);
530 if (parent.equals(this)) {
531 // augment can be declared only under 'module' ...
532 if (!(augmentTargetStr.startsWith("/"))) {
533 throw new YangParseException(
536 "If the 'augment' statement is on the top level in a module, the absolute form of a schema node identifier MUST be used.");
538 augmentBuilders.add(builder);
540 // ... or 'uses' statement
541 if (parent instanceof UsesNodeBuilder) {
542 if (augmentTargetStr.startsWith("/")) {
543 throw new YangParseException(name, line,
544 "If 'augment' statement is a substatement to the 'uses' statement, it cannot contain absolute path ("
545 + augmentTargetStr + ")");
547 ((UsesNodeBuilder) parent).addAugment(builder);
549 throw new YangParseException(name, line, "Augment can be declared only under module or uses statement.");
552 allAugments.add(builder);
558 public void addUsesNode(UsesNodeBuilder usesBuilder) {
559 addedUsesNodes.add(usesBuilder);
560 allUsesNodes.add(usesBuilder);
563 public UsesNodeBuilder addUsesNode(final int line, final String groupingPathStr) {
564 final UsesNodeBuilder usesBuilder = new UsesNodeBuilderImpl(name, line, groupingPathStr);
566 Builder parent = getActualNode();
567 usesBuilder.setParent(parent);
569 if (parent.equals(this)) {
570 addedUsesNodes.add(usesBuilder);
572 if (!(parent instanceof DataNodeContainerBuilder)) {
573 throw new YangParseException(name, line, "Unresolved parent of uses '" + groupingPathStr + "'.");
575 ((DataNodeContainerBuilder) parent).addUsesNode(usesBuilder);
577 if (parent instanceof AugmentationSchemaBuilder) {
578 usesBuilder.setAugmenting(true);
581 allUsesNodes.add(usesBuilder);
585 public void addRefine(final RefineHolder refine) {
586 final Builder parent = getActualNode();
587 if (!(parent instanceof UsesNodeBuilder)) {
588 throw new YangParseException(name, refine.getLine(), "refine can be defined only in uses statement");
590 ((UsesNodeBuilder) parent).addRefine(refine);
591 refine.setParent(parent);
594 public RpcDefinitionBuilder addRpc(final int line, final QName qname, final SchemaPath path) {
595 Builder parent = getActualNode();
596 if (!(parent.equals(this))) {
597 throw new YangParseException(name, line, "rpc can be defined only in module or submodule");
600 final RpcDefinitionBuilder rpcBuilder = new RpcDefinitionBuilder(name, line, qname, path);
601 rpcBuilder.setParent(parent);
603 String rpcName = qname.getLocalName();
604 for (RpcDefinitionBuilder rpc : addedRpcs) {
605 if (rpc.getQName().getLocalName().equals(rpcName)) {
606 raiseYangParserException("", "rpc", rpcName, line, rpc.getLine());
609 for (DataSchemaNodeBuilder addedChild : addedChildNodes) {
610 if (addedChild.getQName().getLocalName().equals(rpcName)) {
611 raiseYangParserException("rpc", "node", rpcName, line, addedChild.getLine());
614 for (NotificationBuilder addedNotification : addedNotifications) {
615 if (addedNotification.getQName().getLocalName().equals(rpcName)) {
616 raiseYangParserException("rpc", "notification", rpcName, line, addedNotification.getLine());
619 addedRpcs.add(rpcBuilder);
623 public ContainerSchemaNodeBuilder addRpcInput(final int line, final QName qname, final SchemaPath schemaPath) {
624 final Builder parent = getActualNode();
625 if (!(parent instanceof RpcDefinitionBuilder)) {
626 throw new YangParseException(name, line, "input can be defined only in rpc statement");
628 final RpcDefinitionBuilder rpc = (RpcDefinitionBuilder) parent;
630 final ContainerSchemaNodeBuilder inputBuilder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
631 inputBuilder.setParent(rpc);
633 rpc.setInput(inputBuilder);
637 public ContainerSchemaNodeBuilder addRpcOutput(final SchemaPath schemaPath, final QName qname, final int line) {
638 final Builder parent = getActualNode();
639 if (!(parent instanceof RpcDefinitionBuilder)) {
640 throw new YangParseException(name, line, "output can be defined only in rpc statement");
642 final RpcDefinitionBuilder rpc = (RpcDefinitionBuilder) parent;
644 final ContainerSchemaNodeBuilder outputBuilder = new ContainerSchemaNodeBuilder(name, line, qname, schemaPath);
645 outputBuilder.setParent(rpc);
647 rpc.setOutput(outputBuilder);
648 return outputBuilder;
651 public void addNotification(NotificationDefinition notification) {
652 notifications.add(notification);
655 public NotificationBuilder addNotification(final int line, final QName qname, final SchemaPath path) {
656 final Builder parent = getActualNode();
657 if (!(parent.equals(this))) {
658 throw new YangParseException(name, line, "notification can be defined only in module or submodule");
661 String notificationName = qname.getLocalName();
662 for (NotificationBuilder nb : addedNotifications) {
663 if (nb.getQName().equals(qname)) {
664 raiseYangParserException("", "notification", notificationName, line, nb.getLine());
667 for (RpcDefinitionBuilder rpc : addedRpcs) {
668 if (rpc.getQName().getLocalName().equals(notificationName)) {
669 raiseYangParserException("notification", "rpc", notificationName, line, rpc.getLine());
672 for (DataSchemaNodeBuilder addedChild : addedChildNodes) {
673 if (addedChild.getQName().getLocalName().equals(notificationName)) {
674 raiseYangParserException("notification", "node", notificationName, line, addedChild.getLine());
678 final NotificationBuilder builder = new NotificationBuilder(name, line, qname, path);
679 builder.setParent(parent);
680 addedNotifications.add(builder);
685 public FeatureBuilder addFeature(final int line, final QName qname, final SchemaPath path) {
686 Builder parent = getActualNode();
687 if (!(parent.equals(this))) {
688 throw new YangParseException(name, line, "feature can be defined only in module or submodule");
691 final FeatureBuilder builder = new FeatureBuilder(name, line, qname, path);
692 builder.setParent(parent);
694 String featureName = qname.getLocalName();
695 for (FeatureBuilder addedFeature : addedFeatures) {
696 if (addedFeature.getQName().getLocalName().equals(featureName)) {
697 raiseYangParserException("", "feature", featureName, line, addedFeature.getLine());
700 addedFeatures.add(builder);
704 public ChoiceBuilder addChoice(final int line, final QName qname, final SchemaPath path) {
705 final ChoiceBuilder builder = new ChoiceBuilder(name, line, qname, path);
707 Builder parent = getActualNode();
708 builder.setParent(parent);
709 addChildToParent(parent, builder, qname.getLocalName());
714 public ChoiceCaseBuilder addCase(final int line, final QName qname, final SchemaPath path) {
715 Builder parent = getActualNode();
716 if (parent == null || parent.equals(this)) {
717 throw new YangParseException(name, line, "'case' parent not found");
720 final ChoiceCaseBuilder builder = new ChoiceCaseBuilder(name, line, qname, path);
721 builder.setParent(parent);
723 if (parent instanceof ChoiceBuilder) {
724 ((ChoiceBuilder) parent).addCase(builder);
725 } else if (parent instanceof AugmentationSchemaBuilder) {
726 ((AugmentationSchemaBuilder) parent).addChildNode(builder);
728 throw new YangParseException(name, line, "Unresolved parent of 'case' " + qname.getLocalName());
734 public AnyXmlBuilder addAnyXml(final int line, final QName qname, final SchemaPath schemaPath) {
735 final AnyXmlBuilder builder = new AnyXmlBuilder(name, line, qname, schemaPath);
737 Builder parent = getActualNode();
738 builder.setParent(parent);
739 addChildToParent(parent, builder, qname.getLocalName());
745 public void addTypedef(TypeDefinitionBuilder typedefBuilder) {
746 String nodeName = typedefBuilder.getQName().getLocalName();
747 for (TypeDefinitionBuilder tdb : addedTypedefs) {
748 if (tdb.getQName().getLocalName().equals(nodeName)) {
749 raiseYangParserException("", "typedef", nodeName, typedefBuilder.getLine(), tdb.getLine());
752 addedTypedefs.add(typedefBuilder);
755 public TypeDefinitionBuilderImpl addTypedef(final int line, final QName qname, final SchemaPath path) {
756 final TypeDefinitionBuilderImpl builder = new TypeDefinitionBuilderImpl(name, line, qname, path);
758 Builder parent = getActualNode();
759 builder.setParent(parent);
761 String typedefName = qname.getLocalName();
762 if (parent.equals(this)) {
763 for (TypeDefinitionBuilder tdb : addedTypedefs) {
764 if (tdb.getQName().getLocalName().equals(typedefName)) {
765 raiseYangParserException("", "typedef", typedefName, line, tdb.getLine());
768 addedTypedefs.add(builder);
770 if (parent instanceof DataNodeContainerBuilder) {
771 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
772 for (TypeDefinitionBuilder child : parentNode.getTypeDefinitionBuilders()) {
773 if (child.getQName().getLocalName().equals(typedefName)) {
774 raiseYangParserException("", "typedef", typedefName, line, child.getLine());
777 parentNode.addTypedef(builder);
778 } else if (parent instanceof RpcDefinitionBuilder) {
779 RpcDefinitionBuilder rpcParent = (RpcDefinitionBuilder) parent;
780 for (TypeDefinitionBuilder tdb : rpcParent.getTypeDefinitions()) {
781 if (tdb.getQName().getLocalName().equals(builder.getQName().getLocalName())) {
782 raiseYangParserException("", "typedef", typedefName, line, tdb.getLine());
785 rpcParent.addTypedef(builder);
787 throw new YangParseException(name, line, "Unresolved parent of typedef " + typedefName);
794 public void setType(final TypeDefinition<?> type) {
795 Builder parent = getActualNode();
796 if (!(parent instanceof TypeAwareBuilder)) {
797 throw new YangParseException("Failed to set type '" + type.getQName().getLocalName()
798 + "'. Invalid parent node: " + parent);
800 ((TypeAwareBuilder) parent).setType(type);
803 public UnionTypeBuilder addUnionType(final int line, final URI namespace, final Date revision) {
804 final Builder parent = getActualNode();
805 if (parent == null) {
806 throw new YangParseException(name, line, "Unresolved parent of union type");
808 final UnionTypeBuilder union = new UnionTypeBuilder(name, line);
809 if (parent instanceof TypeAwareBuilder) {
810 ((TypeAwareBuilder) parent).setTypedef(union);
813 throw new YangParseException(name, line, "Invalid parent of union type.");
818 public void addIdentityrefType(final int line, final SchemaPath schemaPath, final String baseString) {
819 final IdentityrefTypeBuilder identityref = new IdentityrefTypeBuilder(name, line, baseString, schemaPath);
821 final Builder parent = getActualNode();
822 if (parent == null) {
823 throw new YangParseException(name, line, "Unresolved parent of identityref type.");
825 if (parent instanceof TypeAwareBuilder) {
826 final TypeAwareBuilder typeParent = (TypeAwareBuilder) parent;
827 typeParent.setTypedef(identityref);
828 dirtyNodes.add(typeParent);
830 throw new YangParseException(name, line, "Invalid parent of identityref type.");
835 public DeviationBuilder addDeviation(final int line, final String targetPath) {
836 Builder parent = getActualNode();
837 if (!(parent.equals(this))) {
838 throw new YangParseException(name, line, "deviation can be defined only in module or submodule");
841 final DeviationBuilder builder = new DeviationBuilder(name, line, targetPath);
842 builder.setParent(parent);
843 deviationBuilders.add(builder);
847 public IdentitySchemaNodeBuilder addIdentity(final QName qname, final int line, final SchemaPath path) {
848 Builder parent = getActualNode();
849 if (!(parent.equals(this))) {
850 throw new YangParseException(name, line, "identity can be defined only in module or submodule");
852 String identityName = qname.getLocalName();
853 for (IdentitySchemaNodeBuilder idBuilder : addedIdentities) {
854 if (idBuilder.getQName().equals(qname)) {
855 raiseYangParserException("", "identity", identityName, line, idBuilder.getLine());
859 final IdentitySchemaNodeBuilder builder = new IdentitySchemaNodeBuilder(name, line, qname, path);
860 builder.setParent(parent);
861 addedIdentities.add(builder);
866 public void addUnknownNodeBuilder(final UnknownSchemaNodeBuilder builder) {
867 addedUnknownNodes.add(builder);
868 allUnknownNodes.add(builder);
871 public UnknownSchemaNodeBuilder addUnknownSchemaNode(final int line, final QName qname, final SchemaPath path) {
872 final Builder parent = getActualNode();
873 final UnknownSchemaNodeBuilder builder = new UnknownSchemaNodeBuilder(name, line, qname, path);
874 builder.setParent(parent);
875 allUnknownNodes.add(builder);
877 if (parent.equals(this)) {
878 addedUnknownNodes.add(builder);
880 if (parent instanceof SchemaNodeBuilder) {
881 ((SchemaNodeBuilder) parent).addUnknownNodeBuilder(builder);
882 } else if (parent instanceof DataNodeContainerBuilder) {
883 ((DataNodeContainerBuilder) parent).addUnknownNodeBuilder(builder);
884 } else if (parent instanceof RefineHolder) {
885 ((RefineHolder) parent).addUnknownNodeBuilder(builder);
887 throw new YangParseException(name, line, "Unresolved parent of unknown node '" + qname.getLocalName()
895 public Set<RpcDefinition> getRpcs() {
899 public Set<RpcDefinitionBuilder> getAddedRpcs() {
903 public Set<NotificationDefinition> getNotifications() {
904 return notifications;
907 public Set<NotificationBuilder> getAddedNotifications() {
908 return addedNotifications;
912 public String toString() {
913 return "module " + name;
916 public void setSource(String source) {
917 this.source = source;
920 public static final class ModuleImpl implements Module {
921 private URI namespace;
922 private final String name;
923 private final String sourcePath;
924 private Date revision;
925 private String prefix;
926 private String yangVersion;
927 private String description;
928 private String reference;
929 private String organization;
930 private String contact;
931 private final Set<ModuleImport> imports = new HashSet<>();
932 private final Set<FeatureDefinition> features = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
933 private final Set<TypeDefinition<?>> typeDefinitions = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
934 private final Set<NotificationDefinition> notifications = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
935 private final Set<AugmentationSchema> augmentations = new HashSet<>();
936 private final Set<RpcDefinition> rpcs = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
937 private final Set<Deviation> deviations = new HashSet<>();
938 private final Set<DataSchemaNode> childNodes = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
939 private final Set<GroupingDefinition> groupings = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
940 private final Set<UsesNode> uses = new HashSet<>();
941 private final List<ExtensionDefinition> extensionNodes = new ArrayList<>();
942 private final Set<IdentitySchemaNode> identities = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
943 private final List<UnknownSchemaNode> unknownNodes = new ArrayList<>();
944 private String source;
946 private ModuleImpl(String name, String sourcePath) {
948 this.sourcePath = sourcePath;
952 public String getModuleSourcePath() {
957 public URI getNamespace() {
961 private void setNamespace(URI namespace) {
962 this.namespace = namespace;
966 public String getName() {
971 public Date getRevision() {
975 private void setRevision(Date revision) {
976 this.revision = revision;
980 public String getPrefix() {
984 private void setPrefix(String prefix) {
985 this.prefix = prefix;
989 public String getYangVersion() {
993 private void setYangVersion(String yangVersion) {
994 this.yangVersion = yangVersion;
998 public String getDescription() {
1002 private void setDescription(String description) {
1003 this.description = description;
1007 public String getReference() {
1011 private void setReference(String reference) {
1012 this.reference = reference;
1016 public String getOrganization() {
1017 return organization;
1020 private void setOrganization(String organization) {
1021 this.organization = organization;
1025 public String getContact() {
1029 private void setContact(String contact) {
1030 this.contact = contact;
1034 public Set<ModuleImport> getImports() {
1038 private void setImports(Set<ModuleImport> imports) {
1039 if (imports != null) {
1040 this.imports.addAll(imports);
1045 public Set<FeatureDefinition> getFeatures() {
1049 private void setFeatures(Set<FeatureDefinition> features) {
1050 if (features != null) {
1051 this.features.addAll(features);
1056 public Set<TypeDefinition<?>> getTypeDefinitions() {
1057 return typeDefinitions;
1060 private void setTypeDefinitions(Set<TypeDefinition<?>> typeDefinitions) {
1061 if (typeDefinitions != null) {
1062 this.typeDefinitions.addAll(typeDefinitions);
1067 public Set<NotificationDefinition> getNotifications() {
1068 return notifications;
1071 private void setNotifications(Set<NotificationDefinition> notifications) {
1072 if (notifications != null) {
1073 this.notifications.addAll(notifications);
1078 public Set<AugmentationSchema> getAugmentations() {
1079 return augmentations;
1082 private void setAugmentations(Set<AugmentationSchema> augmentations) {
1083 if (augmentations != null) {
1084 this.augmentations.addAll(augmentations);
1089 public Set<RpcDefinition> getRpcs() {
1093 private void setRpcs(Set<RpcDefinition> rpcs) {
1095 this.rpcs.addAll(rpcs);
1100 public Set<Deviation> getDeviations() {
1104 private void setDeviations(Set<Deviation> deviations) {
1105 if (deviations != null) {
1106 this.deviations.addAll(deviations);
1111 public Set<DataSchemaNode> getChildNodes() {
1112 return Collections.unmodifiableSet(childNodes);
1115 private void addChildNodes(Set<DataSchemaNode> childNodes) {
1116 if (childNodes != null) {
1117 this.childNodes.addAll(childNodes);
1122 public Set<GroupingDefinition> getGroupings() {
1126 private void setGroupings(Set<GroupingDefinition> groupings) {
1127 if (groupings != null) {
1128 this.groupings.addAll(groupings);
1133 public Set<UsesNode> getUses() {
1137 private void setUses(Set<UsesNode> uses) {
1139 this.uses.addAll(uses);
1144 public List<ExtensionDefinition> getExtensionSchemaNodes() {
1145 Collections.sort(extensionNodes, Comparators.SCHEMA_NODE_COMP);
1146 return extensionNodes;
1149 private void setExtensionSchemaNodes(final List<ExtensionDefinition> extensionNodes) {
1150 if (extensionNodes != null) {
1151 this.extensionNodes.addAll(extensionNodes);
1156 public Set<IdentitySchemaNode> getIdentities() {
1160 private void setIdentities(final Set<IdentitySchemaNode> identities) {
1161 if (identities != null) {
1162 this.identities.addAll(identities);
1167 public List<UnknownSchemaNode> getUnknownSchemaNodes() {
1168 return unknownNodes;
1171 private void setUnknownSchemaNodes(final List<UnknownSchemaNode> unknownNodes) {
1172 if (unknownNodes != null) {
1173 this.unknownNodes.addAll(unknownNodes);
1178 public DataSchemaNode getDataChildByName(QName name) {
1179 return getChildNode(childNodes, name);
1183 public DataSchemaNode getDataChildByName(String name) {
1184 return getChildNode(childNodes, name);
1187 void setSource(String source){
1188 this.source = source;
1191 public String getSource() {
1196 public int hashCode() {
1197 final int prime = 31;
1199 result = prime * result + ((namespace == null) ? 0 : namespace.hashCode());
1200 result = prime * result + ((name == null) ? 0 : name.hashCode());
1201 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
1202 result = prime * result + ((yangVersion == null) ? 0 : yangVersion.hashCode());
1207 public boolean equals(Object obj) {
1214 if (getClass() != obj.getClass()) {
1217 ModuleImpl other = (ModuleImpl) obj;
1218 if (namespace == null) {
1219 if (other.namespace != null) {
1222 } else if (!namespace.equals(other.namespace)) {
1226 if (other.name != null) {
1229 } else if (!name.equals(other.name)) {
1232 if (revision == null) {
1233 if (other.revision != null) {
1236 } else if (!revision.equals(other.revision)) {
1239 if (yangVersion == null) {
1240 if (other.yangVersion != null) {
1243 } else if (!yangVersion.equals(other.yangVersion)) {
1250 public String toString() {
1251 StringBuilder sb = new StringBuilder(ModuleImpl.class.getSimpleName());
1253 sb.append("name=" + name);
1254 sb.append(", namespace=" + namespace);
1255 sb.append(", revision=" + revision);
1256 sb.append(", prefix=" + prefix);
1257 sb.append(", yangVersion=" + yangVersion);
1259 return sb.toString();
1264 * Add child to parent. Method checks for duplicates and add given child
1265 * node to parent. If node with same name is found, throws exception. If
1266 * parent is null, child node will be added directly to module.
1272 private void addChildToParent(final Builder parent, final DataSchemaNodeBuilder child, final String childName) {
1273 final int lineNum = child.getLine();
1274 if (parent.equals(this)) {
1275 addChildToModule(child, childName, lineNum);
1277 addChildToSubnodeOfModule(parent, child, childName, lineNum);
1282 * Adds child node <code>child</code> to the set of nodes child nodes.
1284 * The method reduces the complexity of the method
1285 * {@link #addChildToParent(Builder, DataSchemaNodeBuilder, String)
1286 * addChildToParent}.
1289 * data schema node builder for child node
1291 * string with name of child node
1293 * line number in YANG file where is the node with the name equal
1294 * to <code>childName</code> is defined
1296 private void addChildToModule(final DataSchemaNodeBuilder child, final String childName, final int lineNum) {
1297 // if parent == null => node is defined under module
1298 // All leafs, leaf-lists, lists, containers, choices, rpcs,
1299 // notifications, and anyxmls defined within a parent node or at the
1300 // top level of the module or its submodules share the same
1301 // identifier namespace.
1302 for (DataSchemaNodeBuilder childNode : addedChildNodes) {
1303 if (childNode.getQName().getLocalName().equals(childName)) {
1304 raiseYangParserException("'" + child + "'", "node", childName, lineNum, childNode.getLine());
1307 for (RpcDefinitionBuilder rpc : addedRpcs) {
1308 if (rpc.getQName().getLocalName().equals(childName)) {
1309 raiseYangParserException("'" + child + "'", "rpc", childName, lineNum, rpc.getLine());
1312 for (NotificationBuilder notification : addedNotifications) {
1313 if (notification.getQName().getLocalName().equals(childName)) {
1314 raiseYangParserException("'" + child + "'", "notification", childName, lineNum, notification.getLine());
1317 addedChildNodes.add(child);
1321 * Adds child node <code>child</code> to the group of child nodes of the
1322 * <code>parent</code>
1324 * The method reduces the complexity of the method
1325 * {@link #addChildToParent(Builder, DataSchemaNodeBuilder, String)
1326 * addChildToParent}. *
1329 * builder of node which is parent for <code>child</code>
1331 * data schema node builder for child node
1333 * string with name of child node
1335 * line number in YANG file where is the node with the name equal
1336 * to <code>childName</code> is defined
1338 private void addChildToSubnodeOfModule(final Builder parent, final DataSchemaNodeBuilder child,
1339 final String childName, final int lineNum) {
1340 // no need for checking rpc and notification because they can be
1341 // defined only under module or submodule
1342 if (parent instanceof DataNodeContainerBuilder) {
1343 DataNodeContainerBuilder parentNode = (DataNodeContainerBuilder) parent;
1344 for (DataSchemaNodeBuilder childNode : parentNode.getChildNodeBuilders()) {
1345 if (childNode.getQName().getLocalName().equals(childName)) {
1346 raiseYangParserException("'" + child + "'", "node", childName, lineNum, childNode.getLine());
1349 parentNode.addChildNode(child);
1350 } else if (parent instanceof ChoiceBuilder) {
1351 ChoiceBuilder parentNode = (ChoiceBuilder) parent;
1352 for (ChoiceCaseBuilder caseBuilder : parentNode.getCases()) {
1353 if (caseBuilder.getQName().getLocalName().equals(childName)) {
1354 raiseYangParserException("'" + child + "'", "node", childName, lineNum, caseBuilder.getLine());
1357 parentNode.addCase(child);
1359 throw new YangParseException(name, lineNum, "Unresolved parent of node '" + childName + "'.");
1363 private ModuleImport createModuleImport(final String moduleName, final Date revision, final String prefix) {
1364 final ModuleImport moduleImport = new ModuleImportImpl(moduleName, revision, prefix);
1365 return moduleImport;
1368 private void raiseYangParserException(final String cantAddType, final String type, final String name,
1369 final int currentLine, final int duplicateLine) {
1371 StringBuilder msgPrefix = new StringBuilder("");
1372 if (cantAddType != null && !cantAddType.isEmpty()) {
1373 msgPrefix.append("Can not add ");
1374 msgPrefix.append(cantAddType);
1375 msgPrefix.append(": ");
1378 String msg = String.format("%s%s with same name '%s' already declared at line %d.", msgPrefix, type, name,
1380 throw new YangParseException(moduleName, currentLine, msg);
1384 public int hashCode() {
1385 final int prime = 31;
1387 result = prime * result + ((name == null) ? 0 : name.hashCode());
1388 result = prime * result + ((namespace == null) ? 0 : namespace.hashCode());
1389 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
1390 result = prime * result + ((prefix == null) ? 0 : prefix.hashCode());
1396 public boolean equals(Object obj) {
1403 if (getClass() != obj.getClass()) {
1406 ModuleBuilder other = (ModuleBuilder) obj;
1408 if (other.name != null) {
1411 } else if (!name.equals(other.name)) {
1414 if (namespace == null) {
1415 if (other.namespace != null) {
1418 } else if (!namespace.equals(other.namespace)) {
1421 if (prefix == null) {
1422 if (other.prefix != null) {
1425 } else if (!prefix.equals(other.prefix)) {
1428 if (revision == null) {
1429 if (other.revision != null) {
1432 } else if (!revision.equals(other.revision)) {