parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/RefineStatementSupport.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.annotations.Beta;
  11 import com.google.common.collect.ImmutableList;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  14 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  15 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.RefineEffectiveStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  20 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  21 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  22 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  23 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  32
  33 @Beta
  34 public abstract sealed class RefineStatementSupport
  35         extends AbstractStatementSupport<Descendant, RefineStatement, RefineEffectiveStatement> {
  36     private static final class Rfc6020 extends RefineStatementSupport {
  37         private static final SubstatementValidator VALIDATOR = SubstatementValidator.builder(YangStmtMapping.REFINE)
  38             .addOptional(YangStmtMapping.DEFAULT)
  39             .addOptional(YangStmtMapping.DESCRIPTION)
  40             .addOptional(YangStmtMapping.REFERENCE)
  41             .addOptional(YangStmtMapping.CONFIG)
  42             .addOptional(YangStmtMapping.MANDATORY)
  43             .addOptional(YangStmtMapping.PRESENCE)
  44             .addAny(YangStmtMapping.MUST)
  45             .addOptional(YangStmtMapping.MIN_ELEMENTS)
  46             .addOptional(YangStmtMapping.MAX_ELEMENTS)
  47             .build();
  48
  49         Rfc6020(final YangParserConfiguration config) {
  50             super(config, VALIDATOR);
  51         }
  52     }
  53
  54     private static final class Rfc7950 extends RefineStatementSupport {
  55         private static final SubstatementValidator VALIDATOR = SubstatementValidator.builder(YangStmtMapping.REFINE)
  56             .addOptional(YangStmtMapping.DEFAULT)
  57             .addOptional(YangStmtMapping.DESCRIPTION)
  58             .addOptional(YangStmtMapping.REFERENCE)
  59             .addOptional(YangStmtMapping.CONFIG)
  60             .addAny(YangStmtMapping.IF_FEATURE)
  61             .addOptional(YangStmtMapping.MANDATORY)
  62             .addOptional(YangStmtMapping.PRESENCE)
  63             .addAny(YangStmtMapping.MUST)
  64             .addOptional(YangStmtMapping.MIN_ELEMENTS)
  65             .addOptional(YangStmtMapping.MAX_ELEMENTS)
  66             .build();
  67
  68         Rfc7950(final YangParserConfiguration config) {
  69             super(config, VALIDATOR);
  70         }
  71
  72         @Override
  73         public void onFullDefinitionDeclared(
  74                 final Mutable<Descendant, RefineStatement, RefineEffectiveStatement> stmt) {
  75             super.onFullDefinitionDeclared(stmt);
  76
  77             if (!StmtContextUtils.evaluateIfFeatures(stmt)) {
  78                 stmt.setUnsupported();
  79             }
  80         }
  81     }
  82
  83     private RefineStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  84         super(YangStmtMapping.REFINE, StatementPolicy.reject(), config, validator);
  85     }
  86
  87     public static @NonNull RefineStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  88         return new Rfc6020(config);
  89     }
  90
  91     public static @NonNull RefineStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  92         return new Rfc7950(config);
  93     }
  94
  95     @Override
  96     public final Descendant parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  97         return ArgumentUtils.parseDescendantSchemaNodeIdentifier(ctx, value);
  98     }
  99
 100     @Override
 101     protected final RefineStatement createDeclared(final BoundStmtCtx<Descendant> ctx,
 102             final ImmutableList<DeclaredStatement<?>> substatements) {
 103         return DeclaredStatements.createRefine(ctx.getRawArgument(), ctx.getArgument(), substatements);
 104     }
 105
 106     @Override
 107     protected final RefineStatement attachDeclarationReference(final RefineStatement stmt,
 108             final DeclarationReference reference) {
 109         return DeclaredStatementDecorators.decorateRefine(stmt, reference);
 110     }
 111
 112     @Override
 113     protected final RefineEffectiveStatement createEffective(final Current<Descendant, RefineStatement> stmt,
 114             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 115         return EffectiveStatements.createRefine(stmt.declared(), substatements);
 116     }
 117 }