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.ImmutableSet;
17 import java.util.ArrayList;
18 import java.util.HashSet;
19 import java.util.LinkedHashSet;
20 import java.util.List;
21 import java.util.Optional;
23 import org.eclipse.jdt.annotation.NonNull;
24 import org.opendaylight.yangtools.concepts.SemVer;
25 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
26 import org.opendaylight.yangtools.yang.common.QName;
27 import org.opendaylight.yangtools.yang.common.Revision;
28 import org.opendaylight.yangtools.yang.common.YangVersion;
29 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.Deviation;
32 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
33 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
34 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
35 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.Module;
37 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
38 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
39 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
40 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
41 import org.opendaylight.yangtools.yang.model.api.UsesNode;
42 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
43 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
44 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
45 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
46 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
47 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
48 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
49 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
50 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
51 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
52 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
55 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends
56 AbstractSchemaEffectiveDocumentedNode<String, D> implements Module,
57 NotificationNodeContainerCompat<String, D> {
58 private final String name;
59 private final String prefix;
60 private final YangVersion yangVersion;
61 private final String organization;
62 private final String contact;
63 private final ImmutableSet<ModuleImport> imports;
64 private final ImmutableSet<FeatureDefinition> features;
65 private final @NonNull ImmutableSet<NotificationDefinition> notifications;
66 private final ImmutableSet<AugmentationSchemaNode> augmentations;
67 private final ImmutableSet<RpcDefinition> rpcs;
68 private final ImmutableSet<Deviation> deviations;
69 private final ImmutableList<ExtensionDefinition> extensionNodes;
70 private final ImmutableSet<IdentitySchemaNode> identities;
71 private final ImmutableSet<GroupingDefinition> groupings;
72 private final ImmutableSet<UsesNode> uses;
73 private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
74 private final ImmutableSet<DataSchemaNode> publicChildNodes;
75 private final SemVer semanticVersion;
77 protected AbstractEffectiveModule(
78 final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
79 final @NonNull String prefix) {
82 this.name = argument();
83 this.prefix = requireNonNull(prefix);
84 this.yangVersion = findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
85 .orElse(YangVersion.VERSION_1);
86 this.semanticVersion = findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class)
88 this.organization = findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class)
90 this.contact = findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class)
93 final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
94 final Set<ModuleImport> importsInit = new HashSet<>();
95 final Set<NotificationDefinition> notificationsInit = new HashSet<>();
96 final Set<RpcDefinition> rpcsInit = new HashSet<>();
97 final Set<Deviation> deviationsInit = new HashSet<>();
98 final Set<IdentitySchemaNode> identitiesInit = new HashSet<>();
99 final Set<FeatureDefinition> featuresInit = new HashSet<>();
100 final List<ExtensionDefinition> extensionNodesInit = new ArrayList<>();
102 final Set<GroupingDefinition> mutableGroupings = new HashSet<>();
103 final Set<UsesNode> mutableUses = new HashSet<>();
104 final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
105 final Set<DataSchemaNode> mutablePublicChildNodes = new LinkedHashSet<>();
107 for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
108 if (effectiveStatement instanceof AugmentationSchemaNode) {
109 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
111 if (effectiveStatement instanceof ModuleImport) {
112 importsInit.add((ModuleImport) effectiveStatement);
114 if (effectiveStatement instanceof NotificationDefinition) {
115 notificationsInit.add((NotificationDefinition) effectiveStatement);
117 if (effectiveStatement instanceof RpcDefinition) {
118 rpcsInit.add((RpcDefinition) effectiveStatement);
120 if (effectiveStatement instanceof Deviation) {
121 deviationsInit.add((Deviation) effectiveStatement);
123 if (effectiveStatement instanceof IdentitySchemaNode) {
124 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
126 if (effectiveStatement instanceof FeatureDefinition) {
127 featuresInit.add((FeatureDefinition) effectiveStatement);
129 if (effectiveStatement instanceof ExtensionDefinition) {
130 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
132 if (effectiveStatement instanceof DataSchemaNode) {
133 mutablePublicChildNodes.add((DataSchemaNode) effectiveStatement);
135 if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
136 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
138 if (effectiveStatement instanceof TypedefEffectiveStatement) {
139 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
140 if (!mutableTypeDefinitions.add(type)) {
141 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
144 if (effectiveStatement instanceof GroupingDefinition
145 && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
146 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
150 this.augmentations = ImmutableSet.copyOf(augmentationsInit);
151 this.imports = ImmutableSet.copyOf(importsInit);
152 this.notifications = ImmutableSet.copyOf(notificationsInit);
153 this.rpcs = ImmutableSet.copyOf(rpcsInit);
154 this.deviations = ImmutableSet.copyOf(deviationsInit);
155 this.identities = ImmutableSet.copyOf(identitiesInit);
156 this.features = ImmutableSet.copyOf(featuresInit);
157 this.extensionNodes = ImmutableList.copyOf(extensionNodesInit);
159 this.groupings = ImmutableSet.copyOf(mutableGroupings);
160 this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
161 this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
162 this.uses = ImmutableSet.copyOf(mutableUses);
166 public URI getNamespace() {
167 return getQNameModule().getNamespace();
171 public String getName() {
176 public Optional<Revision> getRevision() {
177 return getQNameModule().getRevision();
181 public String getPrefix() {
186 public YangVersion getYangVersion() {
191 public Optional<String> getOrganization() {
192 return Optional.ofNullable(organization);
196 public Optional<String> getContact() {
197 return Optional.ofNullable(contact);
201 public Set<ModuleImport> getImports() {
206 public Set<FeatureDefinition> getFeatures() {
211 public Set<NotificationDefinition> getNotifications() {
212 return notifications;
216 public Set<AugmentationSchemaNode> getAugmentations() {
217 return augmentations;
221 public Set<RpcDefinition> getRpcs() {
226 public Set<Deviation> getDeviations() {
231 public List<ExtensionDefinition> getExtensionSchemaNodes() {
232 return extensionNodes;
236 public Set<IdentitySchemaNode> getIdentities() {
241 public final Set<TypeDefinition<?>> getTypeDefinitions() {
242 return typeDefinitions;
246 public final Set<DataSchemaNode> getChildNodes() {
247 return publicChildNodes;
251 public final Set<GroupingDefinition> getGroupings() {
256 @SuppressWarnings("checkstyle:hiddenField")
257 public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
258 return findDataSchemaNode(name);
262 public Set<UsesNode> getUses() {
267 public Optional<SemVer> getSemanticVersion() {
268 return Optional.ofNullable(semanticVersion);
272 public String toString() {
273 return MoreObjects.toStringHelper(this).omitNullValues()
275 .add("namespace", getNamespace())
276 .add("revision", getRevision().orElse(null))
277 .add("prefix", prefix)
278 .add("yangVersion", yangVersion)
282 protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
283 final String type, final String name) {
284 return SourceException.throwIfNull(
285 StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
286 ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);