AbstractEffectiveModule should retain statement order
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / AbstractEffectiveModule.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;
9
10 import static java.util.Objects.requireNonNull;
11
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;
16 import java.net.URI;
17 import java.util.ArrayList;
18 import java.util.LinkedHashSet;
19 import java.util.List;
20 import java.util.Optional;
21 import java.util.Set;
22 import org.eclipse.jdt.annotation.NonNull;
23 import org.opendaylight.yangtools.concepts.SemVer;
24 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
25 import org.opendaylight.yangtools.yang.common.QName;
26 import org.opendaylight.yangtools.yang.common.Revision;
27 import org.opendaylight.yangtools.yang.common.YangVersion;
28 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.Deviation;
31 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
32 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
33 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
34 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.Module;
36 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
37 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
38 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
39 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
40 import org.opendaylight.yangtools.yang.model.api.UsesNode;
41 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
42 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
43 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
44 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
45 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
46 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
47 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
48 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
50 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
51 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
52
53 @Beta
54 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends
55         AbstractSchemaEffectiveDocumentedNode<String, D> implements Module,
56         NotificationNodeContainerCompat<String, D> {
57     private final String name;
58     private final String prefix;
59     private final YangVersion yangVersion;
60     private final String organization;
61     private final String contact;
62     private final ImmutableSet<ModuleImport> imports;
63     private final ImmutableSet<FeatureDefinition> features;
64     private final @NonNull ImmutableSet<NotificationDefinition> notifications;
65     private final ImmutableSet<AugmentationSchemaNode> augmentations;
66     private final ImmutableSet<RpcDefinition> rpcs;
67     private final ImmutableSet<Deviation> deviations;
68     private final ImmutableList<ExtensionDefinition> extensionNodes;
69     private final ImmutableSet<IdentitySchemaNode> identities;
70     private final ImmutableSet<GroupingDefinition> groupings;
71     private final ImmutableSet<UsesNode> uses;
72     private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
73     private final ImmutableSet<DataSchemaNode> publicChildNodes;
74     private final SemVer semanticVersion;
75
76     protected AbstractEffectiveModule(
77             final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
78             final @NonNull String prefix) {
79         super(ctx);
80
81         this.name = argument();
82         this.prefix = requireNonNull(prefix);
83         this.yangVersion = findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
84                 .orElse(YangVersion.VERSION_1);
85         this.semanticVersion = findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class)
86                 .orElse(null);
87         this.organization = findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class)
88                 .orElse(null);
89         this.contact = findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class)
90                 .orElse(null);
91
92         final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
93         final Set<ModuleImport> importsInit = new LinkedHashSet<>();
94         final Set<NotificationDefinition> notificationsInit = new LinkedHashSet<>();
95         final Set<RpcDefinition> rpcsInit = new LinkedHashSet<>();
96         final Set<Deviation> deviationsInit = new LinkedHashSet<>();
97         final Set<IdentitySchemaNode> identitiesInit = new LinkedHashSet<>();
98         final Set<FeatureDefinition> featuresInit = new LinkedHashSet<>();
99         final List<ExtensionDefinition> extensionNodesInit = new ArrayList<>();
100
101         final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
102         final Set<UsesNode> mutableUses = new LinkedHashSet<>();
103         final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
104         final Set<DataSchemaNode> mutablePublicChildNodes = new LinkedHashSet<>();
105
106         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
107             if (effectiveStatement instanceof AugmentationSchemaNode) {
108                 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
109             }
110             if (effectiveStatement instanceof ModuleImport) {
111                 importsInit.add((ModuleImport) effectiveStatement);
112             }
113             if (effectiveStatement instanceof NotificationDefinition) {
114                 notificationsInit.add((NotificationDefinition) effectiveStatement);
115             }
116             if (effectiveStatement instanceof RpcDefinition) {
117                 rpcsInit.add((RpcDefinition) effectiveStatement);
118             }
119             if (effectiveStatement instanceof Deviation) {
120                 deviationsInit.add((Deviation) effectiveStatement);
121             }
122             if (effectiveStatement instanceof IdentitySchemaNode) {
123                 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
124             }
125             if (effectiveStatement instanceof FeatureDefinition) {
126                 featuresInit.add((FeatureDefinition) effectiveStatement);
127             }
128             if (effectiveStatement instanceof ExtensionDefinition) {
129                 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
130             }
131             if (effectiveStatement instanceof DataSchemaNode) {
132                 mutablePublicChildNodes.add((DataSchemaNode) effectiveStatement);
133             }
134             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
135                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
136             }
137             if (effectiveStatement instanceof TypedefEffectiveStatement) {
138                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
139                 if (!mutableTypeDefinitions.add(type)) {
140                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
141                 }
142             }
143             if (effectiveStatement instanceof GroupingDefinition
144                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
145                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
146             }
147         }
148
149         this.augmentations = ImmutableSet.copyOf(augmentationsInit);
150         this.imports = ImmutableSet.copyOf(importsInit);
151         this.notifications = ImmutableSet.copyOf(notificationsInit);
152         this.rpcs = ImmutableSet.copyOf(rpcsInit);
153         this.deviations = ImmutableSet.copyOf(deviationsInit);
154         this.identities = ImmutableSet.copyOf(identitiesInit);
155         this.features = ImmutableSet.copyOf(featuresInit);
156         this.extensionNodes = ImmutableList.copyOf(extensionNodesInit);
157
158         this.groupings = ImmutableSet.copyOf(mutableGroupings);
159         this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
160         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
161         this.uses = ImmutableSet.copyOf(mutableUses);
162     }
163
164     @Override
165     public URI getNamespace() {
166         return getQNameModule().getNamespace();
167     }
168
169     @Override
170     public String getName() {
171         return name;
172     }
173
174     @Override
175     public Optional<Revision> getRevision() {
176         return getQNameModule().getRevision();
177     }
178
179     @Override
180     public String getPrefix() {
181         return prefix;
182     }
183
184     @Override
185     public YangVersion getYangVersion() {
186         return yangVersion;
187     }
188
189     @Override
190     public Optional<String> getOrganization() {
191         return Optional.ofNullable(organization);
192     }
193
194     @Override
195     public Optional<String> getContact() {
196         return Optional.ofNullable(contact);
197     }
198
199     @Override
200     public Set<ModuleImport> getImports() {
201         return imports;
202     }
203
204     @Override
205     public Set<FeatureDefinition> getFeatures() {
206         return features;
207     }
208
209     @Override
210     public Set<NotificationDefinition> getNotifications() {
211         return notifications;
212     }
213
214     @Override
215     public Set<AugmentationSchemaNode> getAugmentations() {
216         return augmentations;
217     }
218
219     @Override
220     public Set<RpcDefinition> getRpcs() {
221         return rpcs;
222     }
223
224     @Override
225     public Set<Deviation> getDeviations() {
226         return deviations;
227     }
228
229     @Override
230     public List<ExtensionDefinition> getExtensionSchemaNodes() {
231         return extensionNodes;
232     }
233
234     @Override
235     public Set<IdentitySchemaNode> getIdentities() {
236         return identities;
237     }
238
239     @Override
240     public final Set<TypeDefinition<?>> getTypeDefinitions() {
241         return typeDefinitions;
242     }
243
244     @Override
245     public final Set<DataSchemaNode> getChildNodes() {
246         return publicChildNodes;
247     }
248
249     @Override
250     public final Set<GroupingDefinition> getGroupings() {
251         return groupings;
252     }
253
254     @Override
255     @SuppressWarnings("checkstyle:hiddenField")
256     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
257         return findDataSchemaNode(name);
258     }
259
260     @Override
261     public Set<UsesNode> getUses() {
262         return uses;
263     }
264
265     @Override
266     public Optional<SemVer> getSemanticVersion() {
267         return Optional.ofNullable(semanticVersion);
268     }
269
270     @Override
271     public String toString() {
272         return MoreObjects.toStringHelper(this).omitNullValues()
273                 .add("name", name)
274                 .add("namespace", getNamespace())
275                 .add("revision", getRevision().orElse(null))
276                 .add("prefix", prefix)
277                 .add("yangVersion", yangVersion)
278                 .toString();
279     }
280
281     protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
282             final String type, final String name) {
283         return SourceException.throwIfNull(
284             StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
285             ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
286     }
287 }