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