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