yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/ActionStatementSupport.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 static com.google.common.base.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableSet;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  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.meta.StatementDefinition;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.ActionStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
  24 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
  25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  27 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins;
  28 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  36 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  37 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  38
  39 public final class ActionStatementSupport extends
  40         AbstractSchemaTreeStatementSupport<ActionStatement, ActionEffectiveStatement> {
  41
  42     private static final ImmutableSet<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(
  43             YangStmtMapping.NOTIFICATION, YangStmtMapping.RPC, YangStmtMapping.ACTION);
  44
  45     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  46         SubstatementValidator.builder(YangStmtMapping.ACTION)
  47             .addOptional(YangStmtMapping.DESCRIPTION)
  48             .addAny(YangStmtMapping.GROUPING)
  49             .addAny(YangStmtMapping.IF_FEATURE)
  50             .addOptional(YangStmtMapping.INPUT)
  51             .addOptional(YangStmtMapping.OUTPUT)
  52             .addOptional(YangStmtMapping.REFERENCE)
  53             .addOptional(YangStmtMapping.STATUS)
  54             .addAny(YangStmtMapping.TYPEDEF)
  55             .build();
  56
  57     private final InputStatementSupport implicitInput;
  58     private final OutputStatementSupport implicitOutput;
  59
  60     public ActionStatementSupport(final YangParserConfiguration config, final InputStatementSupport implicitInput,
  61              final OutputStatementSupport implicitOutput) {
  62         super(YangStmtMapping.ACTION, uninstantiatedPolicy(), config);
  63         this.implicitInput = requireNonNull(implicitInput);
  64         this.implicitOutput = requireNonNull(implicitOutput);
  65     }
  66
  67     @Override
  68     public void onStatementAdded(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  69         final QName argument = stmt.getArgument();
  70         SourceException.throwIf(StmtContextUtils.hasAncestorOfType(stmt, ILLEGAL_PARENTS), stmt,
  71             "Action %s is defined within a notification, rpc or another action", argument);
  72         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.CASE), stmt,
  73             "Action %s is defined within a case statement", argument);
  74         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.MODULE), stmt,
  75             "Action %s is defined at the top level of a module", stmt.getArgument());
  76         StmtContextUtils.validateNoKeylessListAncestorOf(stmt, "Action");
  77
  78         super.onStatementAdded(stmt);
  79     }
  80
  81     @Override
  82     public void onFullDefinitionDeclared(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  83         super.onFullDefinitionDeclared(stmt);
  84
  85         verify(stmt instanceof StatementContextBase);
  86         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  87             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitInput, null);
  88         }
  89         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  90             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implicitOutput, null);
  91         }
  92     }
  93
  94     @Override
  95     protected SubstatementValidator getSubstatementValidator() {
  96         return SUBSTATEMENT_VALIDATOR;
  97     }
  98
  99     @Override
 100     protected ActionStatement createDeclared(final StmtContext<QName, ActionStatement, ?> ctx,
 101             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 102         return DeclaredStatements.createAction(ctx.getArgument(), substatements);
 103     }
 104
 105     @Override
 106     protected ActionEffectiveStatement createEffective(final Current<QName, ActionStatement> stmt,
 107             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 108         final StatementSourceReference ref = stmt.sourceReference();
 109         verify(!substatements.isEmpty(), "Missing implicit input/output statements at %s", ref);
 110
 111         try {
 112             return EffectiveStatements.createAction(stmt.declared(), stmt.effectivePath(),
 113                 EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements), substatements);
 114         } catch (SubstatementIndexingException e) {
 115             throw new SourceException(e.getMessage(), stmt, e);
 116         }
 117     }
 118
 119     @Override
 120     public ActionEffectiveStatement copyEffective(final Current<QName, ActionStatement> stmt,
 121             final ActionEffectiveStatement original) {
 122         return EffectiveStatements.copyAction(original, stmt.effectivePath(),
 123             EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), original.effectiveSubstatements()));
 124     }
 125 }