yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/list/AbstractListEffectiveStatement.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.list;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  23 import org.opendaylight.yangtools.yang.model.api.UniqueConstraint;
  24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.compat.ActionNodeContainerCompat;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredEffectiveStatement.DefaultWithDataTree;
  30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.ActionNodeContainerMixin;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.AugmentationTargetMixin;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DataNodeContainerMixin;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DataSchemaNodeMixin;
  34 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.MustConstraintMixin;
  35 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.NotificationNodeContainerMixin;
  36 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.UserOrderedMixin;
  37 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.WhenConditionMixin;
  38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  40
  41 abstract class AbstractListEffectiveStatement
  42         extends DefaultWithDataTree<QName, ListStatement, ListEffectiveStatement>
  43         implements ListEffectiveStatement, ListSchemaNode, DerivableSchemaNode,
  44             ActionNodeContainerCompat<QName, ListStatement>, NotificationNodeContainerCompat<QName, ListStatement>,
  45             DataSchemaNodeMixin<QName, ListStatement>, UserOrderedMixin<QName, ListStatement>,
  46             DataNodeContainerMixin<QName, ListStatement>, WhenConditionMixin<QName, ListStatement>,
  47             AugmentationTargetMixin<QName, ListStatement>, NotificationNodeContainerMixin<QName, ListStatement>,
  48             ActionNodeContainerMixin<QName, ListStatement>, MustConstraintMixin<QName, ListStatement> {
  49     private final int flags;
  50     // Variable: either a single substatement or an ImmutableList
  51     private final @NonNull Object substatements;
  52     private final @NonNull SchemaPath path;
  53     // Variable: either a single QName or an ImmutableList
  54     private final @NonNull Object keyDefinition;
  55
  56     AbstractListEffectiveStatement(final ListStatement declared, final SchemaPath path, final int flags,
  57             final StmtContext<?, ?, ?> ctx, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements,
  58             final ImmutableList<QName> keyDefinition) {
  59         super(declared, ctx, substatements);
  60
  61         EffectiveStmtUtils.checkUniqueGroupings(ctx, substatements);
  62         EffectiveStmtUtils.checkUniqueTypedefs(ctx, substatements);
  63         EffectiveStmtUtils.checkUniqueUses(ctx, substatements);
  64
  65         this.substatements = substatements.size() == 1 ? substatements.get(0) : substatements;
  66         this.path = requireNonNull(path);
  67         this.keyDefinition = keyDefinition.size() == 1 ? keyDefinition.get(0) : keyDefinition;
  68         this.flags = flags;
  69     }
  70
  71     @SuppressWarnings({ "rawtypes", "unchecked" })
  72     @Override
  73     public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
  74         return (ImmutableList) listFrom(substatements, EffectiveStatement.class);
  75     }
  76
  77     @Override
  78     public final int flags() {
  79         return flags;
  80     }
  81
  82     @Override
  83     public final @NonNull QName argument() {
  84         return getQName();
  85     }
  86
  87     @Override
  88     public final SchemaPath getPath() {
  89         return path;
  90     }
  91
  92     @Override
  93     public final boolean isUserOrdered() {
  94         return userOrdered();
  95     }
  96
  97     @Override
  98     public final List<QName> getKeyDefinition() {
  99         return listFrom(keyDefinition, QName.class);
 100     }
 101
 102     @Override
 103     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 104         return findDataSchemaNode(name);
 105     }
 106
 107     @Override
 108     public final Collection<UniqueConstraint> getUniqueConstraints() {
 109         return effectiveSubstatements().stream()
 110                 .filter(UniqueConstraint.class::isInstance)
 111                 .map(UniqueConstraint.class::cast)
 112                 .collect(ImmutableList.toImmutableList());
 113     }
 114
 115     @Override
 116     public final String toString() {
 117         return "list " + getQName().getLocalName();
 118     }
 119
 120     @SuppressWarnings("unchecked")
 121     private static <T> @NonNull ImmutableList<T> listFrom(final Object obj, final Class<T> type) {
 122         if (obj instanceof ImmutableList) {
 123             return (ImmutableList<T>) obj;
 124         }
 125         verify(type.isInstance(obj), "Unexpected list value %s", obj);
 126         return ImmutableList.of(type.cast(obj));
 127     }
 128 }