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