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.HashSet;
  19 import java.util.LinkedHashSet;
  20 import java.util.List;
  21 import java.util.Optional;
  22 import java.util.Set;
  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;
  53
  54 @Beta
  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;
  76
  77     protected AbstractEffectiveModule(
  78             final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
  79             final @NonNull String prefix) {
  80         super(ctx);
  81
  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)
  87                 .orElse(null);
  88         this.organization = findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class)
  89                 .orElse(null);
  90         this.contact = findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class)
  91                 .orElse(null);
  92
  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<>();
 101
 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<>();
 106
 107         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
 108             if (effectiveStatement instanceof AugmentationSchemaNode) {
 109                 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
 110             }
 111             if (effectiveStatement instanceof ModuleImport) {
 112                 importsInit.add((ModuleImport) effectiveStatement);
 113             }
 114             if (effectiveStatement instanceof NotificationDefinition) {
 115                 notificationsInit.add((NotificationDefinition) effectiveStatement);
 116             }
 117             if (effectiveStatement instanceof RpcDefinition) {
 118                 rpcsInit.add((RpcDefinition) effectiveStatement);
 119             }
 120             if (effectiveStatement instanceof Deviation) {
 121                 deviationsInit.add((Deviation) effectiveStatement);
 122             }
 123             if (effectiveStatement instanceof IdentitySchemaNode) {
 124                 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
 125             }
 126             if (effectiveStatement instanceof FeatureDefinition) {
 127                 featuresInit.add((FeatureDefinition) effectiveStatement);
 128             }
 129             if (effectiveStatement instanceof ExtensionDefinition) {
 130                 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
 131             }
 132             if (effectiveStatement instanceof DataSchemaNode) {
 133                 mutablePublicChildNodes.add((DataSchemaNode) effectiveStatement);
 134             }
 135             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
 136                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 137             }
 138             if (effectiveStatement instanceof TypedefEffectiveStatement) {
 139                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
 140                 if (!mutableTypeDefinitions.add(type)) {
 141                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 142                 }
 143             }
 144             if (effectiveStatement instanceof GroupingDefinition
 145                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
 146                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 147             }
 148         }
 149
 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);
 158
 159         this.groupings = ImmutableSet.copyOf(mutableGroupings);
 160         this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
 161         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
 162         this.uses = ImmutableSet.copyOf(mutableUses);
 163     }
 164
 165     @Override
 166     public URI getNamespace() {
 167         return getQNameModule().getNamespace();
 168     }
 169
 170     @Override
 171     public String getName() {
 172         return name;
 173     }
 174
 175     @Override
 176     public Optional<Revision> getRevision() {
 177         return getQNameModule().getRevision();
 178     }
 179
 180     @Override
 181     public String getPrefix() {
 182         return prefix;
 183     }
 184
 185     @Override
 186     public YangVersion getYangVersion() {
 187         return yangVersion;
 188     }
 189
 190     @Override
 191     public Optional<String> getOrganization() {
 192         return Optional.ofNullable(organization);
 193     }
 194
 195     @Override
 196     public Optional<String> getContact() {
 197         return Optional.ofNullable(contact);
 198     }
 199
 200     @Override
 201     public Set<ModuleImport> getImports() {
 202         return imports;
 203     }
 204
 205     @Override
 206     public Set<FeatureDefinition> getFeatures() {
 207         return features;
 208     }
 209
 210     @Override
 211     public Set<NotificationDefinition> getNotifications() {
 212         return notifications;
 213     }
 214
 215     @Override
 216     public Set<AugmentationSchemaNode> getAugmentations() {
 217         return augmentations;
 218     }
 219
 220     @Override
 221     public Set<RpcDefinition> getRpcs() {
 222         return rpcs;
 223     }
 224
 225     @Override
 226     public Set<Deviation> getDeviations() {
 227         return deviations;
 228     }
 229
 230     @Override
 231     public List<ExtensionDefinition> getExtensionSchemaNodes() {
 232         return extensionNodes;
 233     }
 234
 235     @Override
 236     public Set<IdentitySchemaNode> getIdentities() {
 237         return identities;
 238     }
 239
 240     @Override
 241     public final Set<TypeDefinition<?>> getTypeDefinitions() {
 242         return typeDefinitions;
 243     }
 244
 245     @Override
 246     public final Set<DataSchemaNode> getChildNodes() {
 247         return publicChildNodes;
 248     }
 249
 250     @Override
 251     public final Set<GroupingDefinition> getGroupings() {
 252         return groupings;
 253     }
 254
 255     @Override
 256     @SuppressWarnings("checkstyle:hiddenField")
 257     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 258         return findDataSchemaNode(name);
 259     }
 260
 261     @Override
 262     public Set<UsesNode> getUses() {
 263         return uses;
 264     }
 265
 266     @Override
 267     public Optional<SemVer> getSemanticVersion() {
 268         return Optional.ofNullable(semanticVersion);
 269     }
 270
 271     @Override
 272     public String toString() {
 273         return MoreObjects.toStringHelper(this).omitNullValues()
 274                 .add("name", name)
 275                 .add("namespace", getNamespace())
 276                 .add("revision", getRevision().orElse(null))
 277                 .add("prefix", prefix)
 278                 .add("yangVersion", yangVersion)
 279                 .toString();
 280     }
 281
 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);
 287     }
 288 }