yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/action/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.action;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableSet;
  14 import org.opendaylight.yangtools.yang.common.QName;
  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.meta.StatementDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.ActionStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
  23 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
  24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.input.InputStatementRFC7950Support;
  25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.output.OutputStatementRFC7950Support;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  31 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  32 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  33 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  34
  35 public final class ActionStatementSupport extends
  36         BaseSchemaTreeStatementSupport<ActionStatement, ActionEffectiveStatement> {
  37
  38     private static final ImmutableSet<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(
  39             YangStmtMapping.NOTIFICATION, YangStmtMapping.RPC, YangStmtMapping.ACTION);
  40
  41     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  42         YangStmtMapping.ACTION)
  43         .addOptional(YangStmtMapping.DESCRIPTION)
  44         .addAny(YangStmtMapping.GROUPING)
  45         .addAny(YangStmtMapping.IF_FEATURE)
  46         .addOptional(YangStmtMapping.INPUT)
  47         .addOptional(YangStmtMapping.OUTPUT)
  48         .addOptional(YangStmtMapping.REFERENCE)
  49         .addOptional(YangStmtMapping.STATUS)
  50         .addAny(YangStmtMapping.TYPEDEF)
  51         .build();
  52     private static final ActionStatementSupport INSTANCE = new ActionStatementSupport();
  53
  54     private ActionStatementSupport() {
  55         super(YangStmtMapping.ACTION);
  56     }
  57
  58     public static ActionStatementSupport getInstance() {
  59         return INSTANCE;
  60     }
  61
  62     @Override
  63     public void onFullDefinitionDeclared(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  64         super.onFullDefinitionDeclared(stmt);
  65
  66         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  67             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(
  68                 InputStatementRFC7950Support.getInstance(), null);
  69         }
  70         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  71             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(
  72                 OutputStatementRFC7950Support.getInstance(), null);
  73         }
  74     }
  75
  76     @Override
  77     protected SubstatementValidator getSubstatementValidator() {
  78         return SUBSTATEMENT_VALIDATOR;
  79     }
  80
  81     @Override
  82     protected ActionStatement createDeclared(final StmtContext<QName, ActionStatement, ?> ctx,
  83             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  84         return new RegularActionStatement(ctx.getArgument(), substatements);
  85     }
  86
  87     @Override
  88     protected ActionStatement createEmptyDeclared(final StmtContext<QName, ActionStatement, ?> ctx) {
  89         return new EmptyActionStatement(ctx.getArgument());
  90     }
  91
  92     @Override
  93     protected ActionEffectiveStatement createEffective(final Current<QName, ActionStatement> stmt,
  94             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  95         final StatementSourceReference ref = stmt.sourceReference();
  96         checkState(!substatements.isEmpty(), "Missing implicit input/output statements at %s", ref);
  97         final QName argument = stmt.getArgument();
  98         SourceException.throwIf(StmtContextUtils.hasAncestorOfType(stmt, ILLEGAL_PARENTS), ref,
  99             "Action %s is defined within a notification, rpc or another action", argument);
 100         SourceException.throwIf(
 101             !StmtContextUtils.hasAncestorOfTypeWithChildOfType(stmt, YangStmtMapping.LIST, YangStmtMapping.KEY), ref,
 102             "Action %s is defined within a list that has no key statement", argument);
 103         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.CASE), ref,
 104             "Action %s is defined within a case statement", argument);
 105         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.MODULE), ref,
 106             "Action %s is defined at the top level of a module", argument);
 107
 108         return new ActionEffectiveStatementImpl(stmt.declared(), stmt.getSchemaPath(),
 109             historyAndStatusFlags(stmt.history(), substatements), substatements, stmt.sourceReference());
 110     }
 111 }