yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/LeafStatementSupport.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.meta;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import java.util.Collection;
  12 import org.opendaylight.yangtools.yang.common.QName;
  13 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  14 import org.opendaylight.yangtools.yang.model.api.Status;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.LeafEffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.LeafStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  27 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  28 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  29 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  37 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  38
  39 public final class LeafStatementSupport
  40         extends AbstractSchemaTreeStatementSupport<LeafStatement, LeafEffectiveStatement> {
  41     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  42         SubstatementValidator.builder(YangStmtMapping.LEAF)
  43             .addOptional(YangStmtMapping.CONFIG)
  44             .addOptional(YangStmtMapping.DEFAULT)
  45             .addOptional(YangStmtMapping.DESCRIPTION)
  46             .addAny(YangStmtMapping.IF_FEATURE)
  47             .addOptional(YangStmtMapping.MANDATORY)
  48             .addAny(YangStmtMapping.MUST)
  49             .addOptional(YangStmtMapping.REFERENCE)
  50             .addOptional(YangStmtMapping.STATUS)
  51             .addMandatory(YangStmtMapping.TYPE)
  52             .addOptional(YangStmtMapping.UNITS)
  53             .addOptional(YangStmtMapping.WHEN)
  54             .build();
  55
  56     public LeafStatementSupport(final YangParserConfiguration config) {
  57         super(YangStmtMapping.LEAF, instantiatedPolicy(), config);
  58     }
  59
  60     @Override
  61     public void onFullDefinitionDeclared(final Mutable<QName, LeafStatement, LeafEffectiveStatement> ctx) {
  62         super.onFullDefinitionDeclared(ctx);
  63         StmtContextUtils.validateIfFeatureAndWhenOnListKeys(ctx);
  64     }
  65
  66     @Override
  67     protected SubstatementValidator getSubstatementValidator() {
  68         return SUBSTATEMENT_VALIDATOR;
  69     }
  70
  71     @Override
  72     protected LeafStatement createDeclared(final StmtContext<QName, LeafStatement, ?> ctx,
  73             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  74         return DeclaredStatements.createLeaf(ctx.getArgument(), substatements);
  75     }
  76
  77     @Override
  78     protected LeafStatement attachDeclarationReference(final LeafStatement stmt, final DeclarationReference reference) {
  79         return DeclaredStatementDecorators.decorateLeaf(stmt, reference);
  80     }
  81
  82     @Override
  83     public LeafEffectiveStatement copyEffective(final Current<QName, LeafStatement> stmt,
  84             final LeafEffectiveStatement original) {
  85         return EffectiveStatements.copyLeaf(original, stmt.effectivePath(),
  86             computeFlags(stmt, original.effectiveSubstatements()), stmt.original(LeafSchemaNode.class));
  87     }
  88
  89     @Override
  90     protected LeafEffectiveStatement createEffective(final Current<QName, LeafStatement> stmt,
  91             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  92         final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
  93             findFirstStatement(substatements, TypeEffectiveStatement.class), stmt,
  94             "Leaf is missing a 'type' statement");
  95         final String dflt = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
  96         SourceException.throwIf(
  97             EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(stmt.yangVersion(), typeStmt, dflt), stmt,
  98             "Leaf '%s' has default value '%s' marked with an if-feature statement.", stmt.argument(), dflt);
  99
 100         return EffectiveStatements.createLeaf(stmt.declared(), stmt.effectivePath(), computeFlags(stmt, substatements),
 101             substatements, stmt.original(LeafSchemaNode.class));
 102     }
 103
 104     private static int computeFlags(final Current<?, ?> stmt,
 105         final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 106         return new FlagsBuilder()
 107             .setHistory(stmt.history())
 108             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 109             .setConfiguration(stmt.effectiveConfig().asNullable())
 110             .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
 111             .toFlags();
 112     }
 113 }