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