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