yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/leaf_list/LeafListEffectiveStatementImpl.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.leaf_list;
   9
  10 import com.google.common.collect.ImmutableSet;
  11 import java.util.Collection;
  12 import java.util.Objects;
  13 import java.util.Optional;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  17 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  18 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.UnitsEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypeBuilder;
  31 import org.opendaylight.yangtools.yang.model.util.type.ConcreteTypes;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveMustConstraintAwareDataSchemaNode;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  36
  37 final class LeafListEffectiveStatementImpl extends AbstractEffectiveMustConstraintAwareDataSchemaNode<LeafListStatement>
  38         implements LeafListEffectiveStatement, LeafListSchemaNode, DerivableSchemaNode {
  39
  40     private static final String ORDER_BY_USER_KEYWORD = "user";
  41
  42     private final TypeDefinition<?> type;
  43     private final LeafListSchemaNode original;
  44     private final boolean userOrdered;
  45     private final @NonNull ImmutableSet<String> defaultValues;
  46     private final ElementCountConstraint elementCountConstraint;
  47
  48     LeafListEffectiveStatementImpl(
  49             final StmtContext<QName, LeafListStatement, EffectiveStatement<QName, LeafListStatement>> ctx) {
  50         super(ctx);
  51         this.original = (LeafListSchemaNode) ctx.getOriginalCtx().map(StmtContext::buildEffective).orElse(null);
  52
  53         final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
  54             firstSubstatementOfType(TypeEffectiveStatement.class), ctx.getStatementSourceReference(),
  55             "Leaf-list is missing a 'type' statement");
  56
  57         final ConcreteTypeBuilder<?> builder = ConcreteTypes.concreteTypeBuilder(typeStmt.getTypeDefinition(),
  58             ctx.getSchemaPath().get());
  59         final ImmutableSet.Builder<String> defaultValuesBuilder = ImmutableSet.builder();
  60         boolean isUserOrdered = false;
  61         for (final EffectiveStatement<?, ?> stmt : effectiveSubstatements()) {
  62             if (stmt instanceof OrderedByEffectiveStatement) {
  63                 isUserOrdered = ORDER_BY_USER_KEYWORD.equals(stmt.argument());
  64             }
  65
  66             if (stmt instanceof DefaultEffectiveStatement) {
  67                 defaultValuesBuilder.add(((DefaultEffectiveStatement) stmt).argument());
  68             } else if (stmt instanceof DescriptionEffectiveStatement) {
  69                 builder.setDescription(((DescriptionEffectiveStatement)stmt).argument());
  70             } else if (stmt instanceof ReferenceEffectiveStatement) {
  71                 builder.setReference(((ReferenceEffectiveStatement)stmt).argument());
  72             } else if (stmt instanceof StatusEffectiveStatement) {
  73                 builder.setStatus(((StatusEffectiveStatement)stmt).argument());
  74             } else if (stmt instanceof UnitsEffectiveStatement) {
  75                 builder.setUnits(((UnitsEffectiveStatement)stmt).argument());
  76             }
  77         }
  78
  79         // FIXME: We need to interpret the default value in terms of supplied element type
  80         defaultValues = defaultValuesBuilder.build();
  81         SourceException.throwIf(
  82             EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(ctx.getRootVersion(), typeStmt, defaultValues),
  83             ctx.getStatementSourceReference(),
  84             "Leaf-list '%s' has one of its default values '%s' marked with an if-feature statement.",
  85             ctx.getStatementArgument(), defaultValues);
  86
  87         // FIXME: RFC7950 section 7.7.4: we need to check for min-elements and defaultValues conflict
  88
  89         type = builder.build();
  90         userOrdered = isUserOrdered;
  91         elementCountConstraint = EffectiveStmtUtils.createElementCountConstraint(this).orElse(null);
  92     }
  93
  94     @Override
  95     public Collection<String> getDefaults() {
  96         return defaultValues;
  97     }
  98
  99     @Override
 100     public Optional<LeafListSchemaNode> getOriginal() {
 101         return Optional.ofNullable(original);
 102     }
 103
 104     @Override
 105     public TypeDefinition<?> getType() {
 106         return type;
 107     }
 108
 109     @Override
 110     public boolean isUserOrdered() {
 111         return userOrdered;
 112     }
 113
 114     @Override
 115     public Optional<ElementCountConstraint> getElementCountConstraint() {
 116         return Optional.ofNullable(elementCountConstraint);
 117     }
 118
 119     @Override
 120     public int hashCode() {
 121         final int prime = 31;
 122         int result = 1;
 123         result = prime * result + Objects.hashCode(getQName());
 124         result = prime * result + Objects.hashCode(getPath());
 125         return result;
 126     }
 127
 128     @Override
 129     public boolean equals(final Object obj) {
 130         if (this == obj) {
 131             return true;
 132         }
 133         if (obj == null) {
 134             return false;
 135         }
 136         if (getClass() != obj.getClass()) {
 137             return false;
 138         }
 139         final LeafListEffectiveStatementImpl other = (LeafListEffectiveStatementImpl) obj;
 140         return Objects.equals(getQName(), other.getQName()) && Objects.equals(getPath(), other.getPath());
 141     }
 142
 143     @Override
 144     public String toString() {
 145         return LeafListEffectiveStatementImpl.class.getSimpleName() + "[" + getQName() + "]";
 146     }
 147 }