2 * Copyright (c) 2014, 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
9 package org.opendaylight.yangtools.yang.parser.builder.impl;
11 import static com.google.common.base.Preconditions.checkNotNull;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.ImmutableSet;
16 import java.util.Collections;
17 import java.util.Date;
18 import java.util.List;
19 import java.util.NavigableSet;
20 import java.util.Objects;
22 import java.util.TreeSet;
23 import org.opendaylight.yangtools.concepts.Immutable;
24 import org.opendaylight.yangtools.yang.common.QNameModule;
25 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
26 import org.opendaylight.yangtools.yang.model.api.Deviation;
27 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
28 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
29 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.Module;
31 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
32 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
33 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
34 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
36 import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedDataNodeContainer;
37 import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
39 public final class ModuleImpl extends AbstractDocumentedDataNodeContainer implements Module, Immutable {
41 private final QNameModule qnameModule;
42 private final String name;
43 private final String sourcePath;
44 private final String prefix;
45 private final String yangVersion;
46 private final String organization;
47 private final String contact;
48 private final Set<ModuleImport> imports;
49 private final Set<Module> submodules;
50 private final Set<FeatureDefinition> features;
51 private final Set<NotificationDefinition> notifications;
52 private final Set<AugmentationSchema> augmentations;
53 private final Set<RpcDefinition> rpcs;
54 private final Set<Deviation> deviations;
55 private final List<ExtensionDefinition> extensionNodes;
56 private final Set<IdentitySchemaNode> identities;
57 private final List<UnknownSchemaNode> unknownNodes;
58 private final String source;
63 * <b>Note</b>Constructor has intentionality limited visibility to package, since
64 * this class should be only instantiated via builders.
70 ModuleImpl(final String name, final String sourcePath, final ModuleBuilder builder) {
72 this.name = checkNotNull(name, "Missing name");
73 this.sourcePath = sourcePath; //TODO: can this be nullable?
74 this.imports = ImmutableSet.<ModuleImport> copyOf(builder.imports.values());
75 this.submodules = ImmutableSet.<Module> copyOf(builder.submodules);
76 this.prefix = builder.getPrefix();
78 this.qnameModule = QNameModule.cachedReference(QNameModule.create(builder.getNamespace(),
79 builder.getRevision() == null ? null : new Date(builder.getRevision().getTime())));
80 this.yangVersion = builder.getYangVersion();
81 this.organization = builder.getOrganization();
82 this.contact = builder.getContact();
83 this.features = toImmutableSortedSet(builder.getFeatures());
84 this.notifications = toImmutableSortedSet(builder.getNotifications());
85 this.augmentations = ImmutableSet.copyOf(builder.getAugments());
86 this.rpcs = toImmutableSortedSet(builder.getRpcs());
87 this.deviations = ImmutableSet.copyOf(builder.getDeviations());
88 this.extensionNodes = ImmutableList.copyOf(builder.getExtensions());
89 this.identities = ImmutableSet.copyOf(builder.getIdentities());
90 this.unknownNodes = ImmutableList.copyOf(builder.getExtensionInstances());
91 this.source = checkNotNull(builder.getSource(), "Missing source");
96 public String getModuleSourcePath() {
101 public URI getNamespace() {
102 return qnameModule.getNamespace();
106 public String getName() {
111 public Date getRevision() {
112 return qnameModule.getRevision();
116 public String getPrefix() {
121 public String getYangVersion() {
126 public String getOrganization() {
131 public String getContact() {
136 public Set<ModuleImport> getImports() {
141 public Set<Module> getSubmodules() {
146 public Set<FeatureDefinition> getFeatures() {
151 public Set<NotificationDefinition> getNotifications() {
152 return notifications;
156 public Set<AugmentationSchema> getAugmentations() {
157 return augmentations;
161 public Set<RpcDefinition> getRpcs() {
166 public Set<Deviation> getDeviations() {
171 public List<ExtensionDefinition> getExtensionSchemaNodes() {
172 return extensionNodes;
176 public Set<IdentitySchemaNode> getIdentities() {
181 public List<UnknownSchemaNode> getUnknownSchemaNodes() {
186 public String getSource() {
191 public int hashCode() {
192 final int prime = 31;
194 result = prime * result + Objects.hashCode(name);
195 result = prime * result + Objects.hashCode(yangVersion);
196 result = prime * result + qnameModule.hashCode();
201 public boolean equals(final Object obj) {
208 if (getClass() != obj.getClass()) {
211 ModuleImpl other = (ModuleImpl) obj;
213 if (other.name != null) {
216 } else if (!name.equals(other.name)) {
219 if (!qnameModule.equals(other.qnameModule)) {
222 if (yangVersion == null) {
223 if (other.yangVersion != null) {
226 } else if (!yangVersion.equals(other.yangVersion)) {
232 private static <T extends SchemaNode> Set<T> toImmutableSortedSet(final Set<T> original) {
233 NavigableSet<T> sorted = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
234 sorted.addAll(original);
235 return Collections.unmodifiableSet(sorted);
239 public String toString() {
240 StringBuilder sb = new StringBuilder(ModuleImpl.class.getSimpleName());
242 sb.append("name=").append(name);
243 sb.append(", namespace=").append(getNamespace());
244 sb.append(", revision=").append(getRevision());
245 sb.append(", prefix=").append(prefix);
246 sb.append(", yangVersion=").append(yangVersion);
248 return sb.toString();
252 public QNameModule getQNameModule() {