2 * Copyright (c) 2015 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.rfc7950.stmt;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.base.MoreObjects;
14 import com.google.common.collect.ImmutableList;
15 import com.google.common.collect.ImmutableMap;
16 import com.google.common.collect.ImmutableSet;
18 import java.util.ArrayList;
19 import java.util.HashSet;
20 import java.util.LinkedHashMap;
21 import java.util.LinkedHashSet;
22 import java.util.List;
24 import java.util.Optional;
26 import org.eclipse.jdt.annotation.NonNull;
27 import org.opendaylight.yangtools.concepts.SemVer;
28 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
29 import org.opendaylight.yangtools.yang.common.QName;
30 import org.opendaylight.yangtools.yang.common.Revision;
31 import org.opendaylight.yangtools.yang.common.YangVersion;
32 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.Deviation;
35 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
36 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
37 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
38 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.Module;
40 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
41 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
42 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
43 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
44 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.UsesNode;
46 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
47 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
48 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
49 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
50 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
51 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
52 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
53 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
54 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
55 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
56 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
59 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends
60 AbstractSchemaEffectiveDocumentedNode<String, D> implements Module,
61 NotificationNodeContainerCompat<String, D> {
62 private final String name;
63 private final String prefix;
64 private final YangVersion yangVersion;
65 private final String organization;
66 private final String contact;
67 private final ImmutableSet<ModuleImport> imports;
68 private final ImmutableSet<FeatureDefinition> features;
69 private final @NonNull ImmutableSet<NotificationDefinition> notifications;
70 private final ImmutableSet<AugmentationSchemaNode> augmentations;
71 private final ImmutableSet<RpcDefinition> rpcs;
72 private final ImmutableSet<Deviation> deviations;
73 private final ImmutableList<ExtensionDefinition> extensionNodes;
74 private final ImmutableSet<IdentitySchemaNode> identities;
75 private final @NonNull ImmutableList<UnknownSchemaNode> unknownNodes;
76 private final ImmutableMap<QName, DataSchemaNode> childNodes;
77 private final ImmutableSet<GroupingDefinition> groupings;
78 private final ImmutableSet<UsesNode> uses;
79 private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
80 private final ImmutableSet<DataSchemaNode> publicChildNodes;
81 private final SemVer semanticVersion;
83 protected AbstractEffectiveModule(
84 final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
85 final @NonNull String prefix) {
88 this.name = argument();
89 this.prefix = requireNonNull(prefix);
90 this.yangVersion = findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
91 .orElse(YangVersion.VERSION_1);
92 this.semanticVersion = findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class)
94 this.organization = findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class)
96 this.contact = findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class)
99 final List<UnknownSchemaNode> unknownNodesInit = new ArrayList<>();
100 final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
101 final Set<ModuleImport> importsInit = new HashSet<>();
102 final Set<NotificationDefinition> notificationsInit = new HashSet<>();
103 final Set<RpcDefinition> rpcsInit = new HashSet<>();
104 final Set<Deviation> deviationsInit = new HashSet<>();
105 final Set<IdentitySchemaNode> identitiesInit = new HashSet<>();
106 final Set<FeatureDefinition> featuresInit = new HashSet<>();
107 final List<ExtensionDefinition> extensionNodesInit = new ArrayList<>();
109 final Map<QName, DataSchemaNode> mutableChildNodes = new LinkedHashMap<>();
110 final Set<GroupingDefinition> mutableGroupings = new HashSet<>();
111 final Set<UsesNode> mutableUses = new HashSet<>();
112 final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
113 final Set<DataSchemaNode> mutablePublicChildNodes = new LinkedHashSet<>();
115 for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
116 if (effectiveStatement instanceof UnknownSchemaNode) {
117 unknownNodesInit.add((UnknownSchemaNode) effectiveStatement);
119 if (effectiveStatement instanceof AugmentationSchemaNode) {
120 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
122 if (effectiveStatement instanceof ModuleImport) {
123 importsInit.add((ModuleImport) effectiveStatement);
125 if (effectiveStatement instanceof NotificationDefinition) {
126 notificationsInit.add((NotificationDefinition) effectiveStatement);
128 if (effectiveStatement instanceof RpcDefinition) {
129 rpcsInit.add((RpcDefinition) effectiveStatement);
131 if (effectiveStatement instanceof Deviation) {
132 deviationsInit.add((Deviation) effectiveStatement);
134 if (effectiveStatement instanceof IdentitySchemaNode) {
135 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
137 if (effectiveStatement instanceof FeatureDefinition) {
138 featuresInit.add((FeatureDefinition) effectiveStatement);
140 if (effectiveStatement instanceof ExtensionDefinition) {
141 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
143 if (effectiveStatement instanceof DataSchemaNode) {
144 final DataSchemaNode dataSchemaNode = (DataSchemaNode) effectiveStatement;
145 if (!mutableChildNodes.containsKey(dataSchemaNode.getQName())) {
146 mutableChildNodes.put(dataSchemaNode.getQName(), dataSchemaNode);
147 mutablePublicChildNodes.add(dataSchemaNode);
149 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
152 if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
153 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
155 if (effectiveStatement instanceof TypedefEffectiveStatement) {
156 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
157 if (!mutableTypeDefinitions.add(type)) {
158 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
161 if (effectiveStatement instanceof GroupingDefinition
162 && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
163 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
167 this.unknownNodes = ImmutableList.copyOf(unknownNodesInit);
168 this.augmentations = ImmutableSet.copyOf(augmentationsInit);
169 this.imports = ImmutableSet.copyOf(importsInit);
170 this.notifications = ImmutableSet.copyOf(notificationsInit);
171 this.rpcs = ImmutableSet.copyOf(rpcsInit);
172 this.deviations = ImmutableSet.copyOf(deviationsInit);
173 this.identities = ImmutableSet.copyOf(identitiesInit);
174 this.features = ImmutableSet.copyOf(featuresInit);
175 this.extensionNodes = ImmutableList.copyOf(extensionNodesInit);
177 this.childNodes = ImmutableMap.copyOf(mutableChildNodes);
178 this.groupings = ImmutableSet.copyOf(mutableGroupings);
179 this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
180 this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
181 this.uses = ImmutableSet.copyOf(mutableUses);
186 public URI getNamespace() {
187 return getQNameModule().getNamespace();
191 public String getName() {
196 public Optional<Revision> getRevision() {
197 return getQNameModule().getRevision();
201 public String getPrefix() {
206 public YangVersion getYangVersion() {
211 public Optional<String> getOrganization() {
212 return Optional.ofNullable(organization);
216 public Optional<String> getContact() {
217 return Optional.ofNullable(contact);
221 public Set<ModuleImport> getImports() {
226 public Set<FeatureDefinition> getFeatures() {
231 public Set<NotificationDefinition> getNotifications() {
232 return notifications;
236 public Set<AugmentationSchemaNode> getAugmentations() {
237 return augmentations;
241 public Set<RpcDefinition> getRpcs() {
246 public Set<Deviation> getDeviations() {
251 public List<ExtensionDefinition> getExtensionSchemaNodes() {
252 return extensionNodes;
256 public Set<IdentitySchemaNode> getIdentities() {
261 public List<UnknownSchemaNode> getUnknownSchemaNodes() {
266 public final Set<TypeDefinition<?>> getTypeDefinitions() {
267 return typeDefinitions;
271 public final Set<DataSchemaNode> getChildNodes() {
272 return publicChildNodes;
276 public final Set<GroupingDefinition> getGroupings() {
281 @SuppressWarnings("checkstyle:hiddenField")
282 public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
283 // Child nodes are keyed by their container name, so we can do a direct lookup
284 return Optional.ofNullable(childNodes.get(requireNonNull(name)));
288 public Set<UsesNode> getUses() {
293 public Optional<SemVer> getSemanticVersion() {
294 return Optional.ofNullable(semanticVersion);
298 public String toString() {
299 return MoreObjects.toStringHelper(this).omitNullValues()
301 .add("namespace", getNamespace())
302 .add("revision", getRevision().orElse(null))
303 .add("prefix", prefix)
304 .add("yangVersion", yangVersion)
308 protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
309 final String type, final String name) {
310 return SourceException.throwIfNull(
311 StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
312 ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);