yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/ModuleImpl.java

   1 package org.opendaylight.yangtools.yang.parser.builder.impl;
   2
   3 import static com.google.common.base.Preconditions.checkNotNull;
   4
   5 import com.google.common.collect.ImmutableList;
   6 import com.google.common.collect.ImmutableSet;
   7 import java.net.URI;
   8 import java.util.Collections;
   9 import java.util.Date;
  10 import java.util.List;
  11 import java.util.Set;
  12 import java.util.TreeSet;
  13 import org.opendaylight.yangtools.concepts.Immutable;
  14 import org.opendaylight.yangtools.yang.common.QNameModule;
  15 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  16 import org.opendaylight.yangtools.yang.model.api.Deviation;
  17 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  18 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.Module;
  21 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  22 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  24 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  26 import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedDataNodeContainer;
  27 import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
  28
  29 public final class ModuleImpl extends AbstractDocumentedDataNodeContainer implements Module, Immutable {
  30
  31     private final QNameModule qnameModule;
  32     private final String name;
  33     private final String sourcePath;
  34     private final String prefix;
  35     private final String yangVersion;
  36     private final String organization;
  37     private final String contact;
  38     private final Set<ModuleImport> imports;
  39     private final Set<Module> submodules;
  40     private final Set<FeatureDefinition> features;
  41     private final Set<NotificationDefinition> notifications;
  42     private final Set<AugmentationSchema> augmentations;
  43     private final Set<RpcDefinition> rpcs;
  44     private final Set<Deviation> deviations;
  45     private final List<ExtensionDefinition> extensionNodes;
  46     private final Set<IdentitySchemaNode> identities;
  47     private final List<UnknownSchemaNode> unknownNodes;
  48     private final String source;
  49
  50     /**
  51      *
  52      *
  53      * <b>Note</b>Constructor has intentionality limited visibility to package, since
  54      * this class should be only instantiated via builders.
  55      *
  56      * @param name
  57      * @param sourcePath
  58      * @param builder
  59      */
  60     ModuleImpl(final String name, final String sourcePath, final ModuleBuilder builder) {
  61         super(builder);
  62         this.name = checkNotNull(name, "Missing name");
  63         this.sourcePath = sourcePath; //TODO: can this be nullable?
  64         this.imports = ImmutableSet.<ModuleImport> copyOf(builder.imports.values());
  65         this.submodules = ImmutableSet.<Module> copyOf(builder.submodules);
  66         this.prefix = builder.getPrefix();
  67
  68         this.qnameModule = QNameModule.create(builder.getNamespace(),
  69                 builder.getRevision() == null ? null : new Date(builder.getRevision().getTime()));
  70         this.yangVersion = builder.getYangVersion();
  71         this.organization = builder.getOrganization();
  72         this.contact = builder.getContact();
  73         this.features = toImmutableSortedSet(builder.getFeatures());
  74         this.notifications = toImmutableSortedSet(builder.getNotifications());
  75         this.augmentations = ImmutableSet.copyOf(builder.getAugments());
  76         this.rpcs = toImmutableSortedSet(builder.getRpcs());
  77         this.deviations = ImmutableSet.copyOf(builder.getDeviations());
  78         this.extensionNodes = ImmutableList.copyOf(builder.getExtensions());
  79         this.identities = ImmutableSet.copyOf(builder.getIdentities());
  80         this.unknownNodes = ImmutableList.copyOf(builder.getExtensionInstances());
  81         this.source = checkNotNull(builder.getSource(), "Missing source");
  82
  83     }
  84
  85     @Override
  86     public String getModuleSourcePath() {
  87         return sourcePath;
  88     }
  89
  90     @Override
  91     public URI getNamespace() {
  92         return qnameModule.getNamespace();
  93     }
  94
  95     @Override
  96     public String getName() {
  97         return name;
  98     }
  99
 100     @Override
 101     public Date getRevision() {
 102         return qnameModule.getRevision();
 103     }
 104
 105     @Override
 106     public String getPrefix() {
 107         return prefix;
 108     }
 109
 110     @Override
 111     public String getYangVersion() {
 112         return yangVersion;
 113     }
 114
 115     @Override
 116     public String getOrganization() {
 117         return organization;
 118     }
 119
 120     @Override
 121     public String getContact() {
 122         return contact;
 123     }
 124
 125     @Override
 126     public Set<ModuleImport> getImports() {
 127         return imports;
 128     }
 129
 130     @Override
 131     public Set<Module> getSubmodules() {
 132         return submodules;
 133     }
 134
 135     @Override
 136     public Set<FeatureDefinition> getFeatures() {
 137         return features;
 138     }
 139
 140     @Override
 141     public Set<NotificationDefinition> getNotifications() {
 142         return notifications;
 143     }
 144
 145     @Override
 146     public Set<AugmentationSchema> getAugmentations() {
 147         return augmentations;
 148     }
 149
 150     @Override
 151     public Set<RpcDefinition> getRpcs() {
 152         return rpcs;
 153     }
 154
 155     @Override
 156     public Set<Deviation> getDeviations() {
 157         return deviations;
 158     }
 159
 160     @Override
 161     public List<ExtensionDefinition> getExtensionSchemaNodes() {
 162         return extensionNodes;
 163     }
 164
 165     @Override
 166     public Set<IdentitySchemaNode> getIdentities() {
 167         return identities;
 168     }
 169
 170     @Override
 171     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 172         return unknownNodes;
 173     }
 174
 175     @Override
 176     public String getSource() {
 177         return source;
 178     }
 179
 180     @Override
 181     public int hashCode() {
 182         final int prime = 31;
 183         int result = 1;
 184         result = prime * result + ((name == null) ? 0 : name.hashCode());
 185         result = prime * result + ((yangVersion == null) ? 0 : yangVersion.hashCode());
 186         result = prime * result + qnameModule.hashCode();
 187         return result;
 188     }
 189
 190     @Override
 191     public boolean equals(final Object obj) {
 192         if (this == obj) {
 193             return true;
 194         }
 195         if (obj == null) {
 196             return false;
 197         }
 198         if (getClass() != obj.getClass()) {
 199             return false;
 200         }
 201         ModuleImpl other = (ModuleImpl) obj;
 202         if (name == null) {
 203             if (other.name != null) {
 204                 return false;
 205             }
 206         } else if (!name.equals(other.name)) {
 207             return false;
 208         }
 209         if (!qnameModule.equals(other.qnameModule)) {
 210             return false;
 211         }
 212         if (yangVersion == null) {
 213             if (other.yangVersion != null) {
 214                 return false;
 215             }
 216         } else if (!yangVersion.equals(other.yangVersion)) {
 217             return false;
 218         }
 219         return true;
 220     }
 221
 222     private static <T extends SchemaNode> Set<T> toImmutableSortedSet(final Set<T> original) {
 223         TreeSet<T> sorted = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
 224         sorted.addAll(original);
 225         return Collections.unmodifiableSet(sorted);
 226     }
 227
 228     @Override
 229     public String toString() {
 230         StringBuilder sb = new StringBuilder(ModuleImpl.class.getSimpleName());
 231         sb.append("[");
 232         sb.append("name=").append(name);
 233         sb.append(", namespace=").append(getNamespace());
 234         sb.append(", revision=").append(getRevision());
 235         sb.append(", prefix=").append(prefix);
 236         sb.append(", yangVersion=").append(yangVersion);
 237         sb.append("]");
 238         return sb.toString();
 239     }
 240
 241     @Override
 242     public QNameModule getQNameModule() {
 243         return qnameModule;
 244     }
 245 }