yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/AbstractEffectiveSimpleDataNodeContainer.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 com.google.common.collect.ImmutableList;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.ArrayList;
  13 import java.util.LinkedHashSet;
  14 import java.util.List;
  15 import java.util.Optional;
  16 import java.util.Set;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  21 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  23 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  24 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  26 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  31
  32 public abstract class AbstractEffectiveSimpleDataNodeContainer<D extends DeclaredStatement<QName>> extends
  33         AbstractEffectiveDocumentedDataNodeContainer<QName, D> implements AugmentationTarget, DataSchemaNode {
  34
  35     private final ImmutableSet<AugmentationSchemaNode> augmentations;
  36     private final @NonNull ImmutableList<UnknownSchemaNode> unknownNodes;
  37     private final RevisionAwareXPath whenCondition;
  38     private final @NonNull SchemaPath path;
  39     private final boolean configuration;
  40     private final boolean addedByUses;
  41     private final boolean augmenting;
  42
  43     protected AbstractEffectiveSimpleDataNodeContainer(final StmtContext<QName, D, ?> ctx) {
  44         super(ctx);
  45
  46         this.path = ctx.getSchemaPath().get();
  47         this.configuration = ctx.isConfiguration();
  48
  49         whenCondition = findFirstEffectiveSubstatementArgument(WhenEffectiveStatement.class).orElse(null);
  50
  51         // initSubstatementCollectionsAndFields
  52
  53         List<UnknownSchemaNode> unknownNodesInit = new ArrayList<>();
  54         Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
  55         for (EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
  56             if (effectiveStatement instanceof UnknownSchemaNode) {
  57                 unknownNodesInit.add((UnknownSchemaNode) effectiveStatement);
  58             }
  59             if (effectiveStatement instanceof AugmentationSchemaNode) {
  60                 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
  61             }
  62         }
  63         this.unknownNodes = ImmutableList.copyOf(unknownNodesInit);
  64         this.augmentations = ImmutableSet.copyOf(augmentationsInit);
  65
  66         // initCopyType
  67         final CopyHistory copyTypesFromOriginal = ctx.getCopyHistory();
  68         if (copyTypesFromOriginal.contains(CopyType.ADDED_BY_USES_AUGMENTATION)) {
  69             this.augmenting = true;
  70             this.addedByUses = true;
  71         } else {
  72             this.augmenting = copyTypesFromOriginal.contains(CopyType.ADDED_BY_AUGMENTATION);
  73             this.addedByUses = copyTypesFromOriginal.contains(CopyType.ADDED_BY_USES);
  74         }
  75     }
  76
  77     @Override
  78     public QName getQName() {
  79         return path.getLastComponent();
  80     }
  81
  82     @Override
  83     public SchemaPath getPath() {
  84         return path;
  85     }
  86
  87     @Deprecated
  88     @Override
  89     public boolean isAugmenting() {
  90         return augmenting;
  91     }
  92
  93     @Deprecated
  94     @Override
  95     public boolean isAddedByUses() {
  96         return addedByUses;
  97     }
  98
  99     @Override
 100     public boolean isConfiguration() {
 101         return configuration;
 102     }
 103
 104     @Override
 105     public Set<AugmentationSchemaNode> getAvailableAugmentations() {
 106         return augmentations;
 107     }
 108
 109     @Override
 110     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 111         return unknownNodes;
 112     }
 113
 114     @Override
 115     public final Optional<RevisionAwareXPath> getWhenCondition() {
 116         return Optional.ofNullable(whenCondition);
 117     }
 118
 119     /**
 120      * Reset {@link #isAugmenting()} to false.
 121      *
 122      * @deprecated This method is a violation of immutable contract and is a side-effect of bad/incomplete lifecycle,
 123      *             which needs to be fixed. Do not introduce new callers. This deficiency is tracked in YANGTOOLS-724.
 124      */
 125     @Deprecated
 126     public final void resetAugmenting() {
 127         // Intentional no-op
 128     }
 129 }