yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/extension/UnrecognizedStatementSupport.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.extension;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import java.util.Optional;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.meta.ArgumentDefinition;
  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.meta.StatementDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.UnrecognizedStatement;
  20 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.OverrideChildStatementSupport;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  28
  29 final class UnrecognizedStatementSupport
  30         extends AbstractStatementSupport<Object, UnrecognizedStatement, UnrecognizedEffectiveStatement>
  31         implements OverrideChildStatementSupport {
  32     private final YangParserConfiguration config;
  33
  34     UnrecognizedStatementSupport(final StatementDefinition publicDefinition, final YangParserConfiguration config) {
  35         // We have no idea about the statement's semantics, hence there should be noone interested in its semantics.
  36         // Nevertheless it may be of interest for various hacks to understand there was an extension involved.
  37         super(publicDefinition, StatementPolicy.exactReplica(), config);
  38         this.config = requireNonNull(config);
  39     }
  40
  41     @Override
  42     public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  43         return value;
  44     }
  45
  46     @Override
  47     public UnrecognizedStatementSupport statementDefinitionOverrideOf(final StatementDefinition childDef) {
  48         /*
  49          * This code wraps statements encountered inside an extension so they do not get confused with regular
  50          * statements.
  51          */
  52         final QName baseQName = getStatementName();
  53         final QName statementName = QName.create(baseQName, childDef.getStatementName().getLocalName());
  54
  55         final ModelDefinedStatementDefinition def;
  56         final Optional<ArgumentDefinition> optArgDef = childDef.getArgumentDefinition();
  57         if (optArgDef.isPresent()) {
  58             final ArgumentDefinition argDef = optArgDef.get();
  59             def = new ModelDefinedStatementDefinition(statementName, argDef.getArgumentName(), argDef.isYinElement());
  60         } else {
  61             def = new ModelDefinedStatementDefinition(statementName);
  62         }
  63         return new UnrecognizedStatementSupport(def, config);
  64     }
  65
  66     @Override
  67     protected SubstatementValidator getSubstatementValidator() {
  68         // We know nothing about this statement
  69         return null;
  70     }
  71
  72     @Override
  73     protected UnrecognizedStatement createDeclared(final StmtContext<Object, UnrecognizedStatement, ?> ctx,
  74             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  75         return new UnrecognizedStatementImpl(ctx.rawArgument(), ctx.publicDefinition(), substatements);
  76     }
  77
  78     // createEffective() should never be called, ensure that for each declared statement
  79
  80     @Override
  81     public void onStatementAdded(final Mutable<Object, UnrecognizedStatement, UnrecognizedEffectiveStatement> stmt) {
  82         stmt.setIsSupportedToBuildEffective(false);
  83     }
  84
  85     @Override
  86     protected UnrecognizedEffectiveStatement createEffective(final Current<Object, UnrecognizedStatement> stmt,
  87             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  88         throw new InferenceException(stmt, "Attempted to instantiate unrecognized effective statement %s",
  89             stmt.publicDefinition());
  90     }
  91 }