yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/leaf_list/LeafListStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, 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.leaf_list;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableSet;
  15 import java.util.Optional;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.yang.common.Ordering;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  20 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  22 import org.opendaylight.yangtools.yang.model.api.Status;
  23 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  25 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  34 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  39
  40 @Beta
  41 public final class LeafListStatementSupport
  42         extends BaseSchemaTreeStatementSupport<LeafListStatement, LeafListEffectiveStatement> {
  43     private static final @NonNull LeafListStatementSupport RFC6020_INSTANCE = new LeafListStatementSupport(
  44         SubstatementValidator.builder(YangStmtMapping.LEAF_LIST)
  45             .addOptional(YangStmtMapping.CONFIG)
  46             .addOptional(YangStmtMapping.DESCRIPTION)
  47             .addAny(YangStmtMapping.IF_FEATURE)
  48             .addOptional(YangStmtMapping.MIN_ELEMENTS)
  49             .addOptional(YangStmtMapping.MAX_ELEMENTS)
  50             .addAny(YangStmtMapping.MUST)
  51             .addOptional(YangStmtMapping.ORDERED_BY)
  52             .addOptional(YangStmtMapping.REFERENCE)
  53             .addOptional(YangStmtMapping.STATUS)
  54             .addMandatory(YangStmtMapping.TYPE)
  55             .addOptional(YangStmtMapping.UNITS)
  56             .addOptional(YangStmtMapping.WHEN)
  57             .build());
  58     private static final @NonNull LeafListStatementSupport RFC7950_INSTANCE = new LeafListStatementSupport(
  59         SubstatementValidator.builder(YangStmtMapping
  60             .LEAF_LIST)
  61             .addOptional(YangStmtMapping.CONFIG)
  62             .addAny(YangStmtMapping.DEFAULT)
  63             .addOptional(YangStmtMapping.DESCRIPTION)
  64             .addAny(YangStmtMapping.IF_FEATURE)
  65             .addOptional(YangStmtMapping.MIN_ELEMENTS)
  66             .addOptional(YangStmtMapping.MAX_ELEMENTS)
  67             .addAny(YangStmtMapping.MUST)
  68             .addOptional(YangStmtMapping.ORDERED_BY)
  69             .addOptional(YangStmtMapping.REFERENCE)
  70             .addOptional(YangStmtMapping.STATUS)
  71             .addMandatory(YangStmtMapping.TYPE)
  72             .addOptional(YangStmtMapping.UNITS)
  73             .addOptional(YangStmtMapping.WHEN)
  74             .build());
  75
  76     private final SubstatementValidator validator;
  77
  78     private LeafListStatementSupport(final SubstatementValidator validator) {
  79         super(YangStmtMapping.LEAF_LIST, CopyPolicy.DECLARED_COPY);
  80         this.validator = requireNonNull(validator);
  81     }
  82
  83     public static @NonNull LeafListStatementSupport rfc6020Instance() {
  84         return RFC6020_INSTANCE;
  85     }
  86
  87     public static @NonNull LeafListStatementSupport rfc7950Instance() {
  88         return RFC7950_INSTANCE;
  89     }
  90
  91     @Override
  92     protected SubstatementValidator getSubstatementValidator() {
  93         return validator;
  94     }
  95
  96     @Override
  97     protected LeafListStatement createDeclared(final StmtContext<QName, LeafListStatement, ?> ctx,
  98             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  99         return new RegularLeafListStatement(ctx.getArgument(), substatements);
 100     }
 101
 102     @Override
 103     protected LeafListStatement createEmptyDeclared(final StmtContext<QName, LeafListStatement, ?> ctx) {
 104         return new EmptyLeafListStatement(ctx.getArgument());
 105     }
 106
 107     @Override
 108     protected LeafListEffectiveStatement createEffective(final Current<QName, LeafListStatement> stmt,
 109             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 110         final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
 111                 findFirstStatement(substatements, TypeEffectiveStatement.class), stmt,
 112                 "Leaf-list is missing a 'type' statement");
 113
 114         final LeafListSchemaNode original = (LeafListSchemaNode) stmt.original();
 115
 116         final int flags = new FlagsBuilder()
 117                 .setHistory(stmt.history())
 118                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 119                 .setConfiguration(stmt.effectiveConfig().asNullable())
 120                 .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
 121                     .equals(Ordering.USER))
 122                 .toFlags();
 123         final ImmutableSet<String> defaultValues = substatements.stream()
 124                 .filter(DefaultEffectiveStatement.class::isInstance)
 125                 .map(DefaultEffectiveStatement.class::cast)
 126                 .map(DefaultEffectiveStatement::argument)
 127                 .collect(ImmutableSet.toImmutableSet());
 128
 129         // FIXME: We need to interpret the default value in terms of supplied element type
 130         SourceException.throwIf(
 131                 EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(stmt.yangVersion(), typeStmt, defaultValues),
 132                 stmt, "Leaf-list '%s' has one of its default values '%s' marked with an if-feature statement.",
 133                 stmt.argument(), defaultValues);
 134
 135         // FIXME: RFC7950 section 7.7.4: we need to check for min-elements and defaultValues conflict
 136
 137         final Optional<ElementCountConstraint> elementCountConstraint =
 138                 EffectiveStmtUtils.createElementCountConstraint(substatements);
 139
 140         final LeafListStatement declared = stmt.declared();
 141         final SchemaPath path = stmt.wrapSchemaPath();
 142         if (defaultValues.isEmpty()) {
 143             return original == null && !elementCountConstraint.isPresent()
 144                 ? new EmptyLeafListEffectiveStatement(declared, path, flags, substatements)
 145                     : new SlimLeafListEffectiveStatement(declared, path, flags, substatements, original,
 146                         elementCountConstraint.orElse(null));
 147         }
 148
 149         return new RegularLeafListEffectiveStatement(declared, path, flags, substatements, original, defaultValues,
 150             elementCountConstraint.orElse(null));
 151     }
 152 }