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.Verify.verify;
  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.SubstatementIndexingException;
  25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.input.InputStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.output.OutputStatementSupport;
  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 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  33 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  35
  36 public final class ActionStatementSupport extends
  37         BaseSchemaTreeStatementSupport<ActionStatement, ActionEffectiveStatement> {
  38
  39     private static final ImmutableSet<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(
  40             YangStmtMapping.NOTIFICATION, YangStmtMapping.RPC, YangStmtMapping.ACTION);
  41
  42     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  43         YangStmtMapping.ACTION)
  44         .addOptional(YangStmtMapping.DESCRIPTION)
  45         .addAny(YangStmtMapping.GROUPING)
  46         .addAny(YangStmtMapping.IF_FEATURE)
  47         .addOptional(YangStmtMapping.INPUT)
  48         .addOptional(YangStmtMapping.OUTPUT)
  49         .addOptional(YangStmtMapping.REFERENCE)
  50         .addOptional(YangStmtMapping.STATUS)
  51         .addAny(YangStmtMapping.TYPEDEF)
  52         .build();
  53     private static final ActionStatementSupport INSTANCE = new ActionStatementSupport();
  54
  55     private ActionStatementSupport() {
  56         super(YangStmtMapping.ACTION, CopyPolicy.DECLARED_COPY);
  57     }
  58
  59     public static ActionStatementSupport getInstance() {
  60         return INSTANCE;
  61     }
  62
  63     @Override
  64     public void onStatementAdded(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  65         final QName argument = stmt.getArgument();
  66         SourceException.throwIf(StmtContextUtils.hasAncestorOfType(stmt, ILLEGAL_PARENTS), stmt,
  67             "Action %s is defined within a notification, rpc or another action", argument);
  68         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.CASE), stmt,
  69             "Action %s is defined within a case statement", argument);
  70         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.MODULE), stmt,
  71             "Action %s is defined at the top level of a module", stmt.getArgument());
  72         StmtContextUtils.validateNoKeylessListAncestorOf(stmt, "Action");
  73
  74         super.onStatementAdded(stmt);
  75     }
  76
  77     @Override
  78     public void onFullDefinitionDeclared(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  79         super.onFullDefinitionDeclared(stmt);
  80
  81         verify(stmt instanceof StatementContextBase);
  82         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  83             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(
  84                 InputStatementSupport.rfc7950Instance(), null);
  85         }
  86         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  87             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(
  88                 OutputStatementSupport.rfc7950Instance(), null);
  89         }
  90     }
  91
  92     @Override
  93     protected SubstatementValidator getSubstatementValidator() {
  94         return SUBSTATEMENT_VALIDATOR;
  95     }
  96
  97     @Override
  98     protected ActionStatement createDeclared(final StmtContext<QName, ActionStatement, ?> ctx,
  99             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 100         return new RegularActionStatement(ctx.getArgument(), substatements);
 101     }
 102
 103     @Override
 104     protected ActionStatement createEmptyDeclared(final StmtContext<QName, ActionStatement, ?> ctx) {
 105         return new EmptyActionStatement(ctx.getArgument());
 106     }
 107
 108     @Override
 109     protected ActionEffectiveStatement createEffective(final Current<QName, ActionStatement> stmt,
 110             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 111         final StatementSourceReference ref = stmt.sourceReference();
 112         verify(!substatements.isEmpty(), "Missing implicit input/output statements at %s", ref);
 113
 114         try {
 115             return new ActionEffectiveStatementImpl(stmt.declared(), stmt.wrapSchemaPath(),
 116                 historyAndStatusFlags(stmt.history(), substatements), substatements);
 117         } catch (SubstatementIndexingException e) {
 118             throw new SourceException(e.getMessage(), stmt, e);
 119         }
 120     }
 121 }