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.ImmutableList;
  11 import com.google.common.collect.ImmutableSet;
  12 import org.opendaylight.yangtools.yang.common.QName;
  13 import org.opendaylight.yangtools.yang.model.api.Status;
  14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  15 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  17 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.ActionStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
  24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
  25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  26 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.input.InputStatementRFC7950Support;
  27 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.output.OutputStatementRFC7950Support;
  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 BaseQNameStatementSupport<ActionStatement, ActionEffectiveStatement> {
  37     private static final ImmutableSet<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(
  38             YangStmtMapping.NOTIFICATION, YangStmtMapping.RPC, YangStmtMapping.ACTION);
  39
  40     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  41         YangStmtMapping.ACTION)
  42         .addOptional(YangStmtMapping.DESCRIPTION)
  43         .addAny(YangStmtMapping.GROUPING)
  44         .addAny(YangStmtMapping.IF_FEATURE)
  45         .addOptional(YangStmtMapping.INPUT)
  46         .addOptional(YangStmtMapping.OUTPUT)
  47         .addOptional(YangStmtMapping.REFERENCE)
  48         .addOptional(YangStmtMapping.STATUS)
  49         .addAny(YangStmtMapping.TYPEDEF)
  50         .build();
  51     private static final ActionStatementSupport INSTANCE = new ActionStatementSupport();
  52
  53     private ActionStatementSupport() {
  54         super(YangStmtMapping.ACTION);
  55     }
  56
  57     public static ActionStatementSupport getInstance() {
  58         return INSTANCE;
  59     }
  60
  61     @Override
  62     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  63         return StmtContextUtils.parseIdentifier(ctx, value);
  64     }
  65
  66     @Override
  67     public void onStatementAdded(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  68         stmt.coerceParentContext().addToNs(ChildSchemaNodeNamespace.class, stmt.coerceStatementArgument(), stmt);
  69     }
  70
  71     @Override
  72     public void onFullDefinitionDeclared(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  73         super.onFullDefinitionDeclared(stmt);
  74
  75         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  76             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(
  77                 InputStatementRFC7950Support.getInstance(), null);
  78         }
  79         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  80             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(
  81                 OutputStatementRFC7950Support.getInstance(), null);
  82         }
  83     }
  84
  85     @Override
  86     protected SubstatementValidator getSubstatementValidator() {
  87         return SUBSTATEMENT_VALIDATOR;
  88     }
  89
  90     @Override
  91     protected ActionStatement createDeclared(final StmtContext<QName, ActionStatement, ?> ctx,
  92             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  93         return new RegularActionStatement(ctx.coerceStatementArgument(), substatements);
  94     }
  95
  96     @Override
  97     protected ActionStatement createEmptyDeclared(final StmtContext<QName, ActionStatement, ?> ctx) {
  98         return new EmptyActionStatement(ctx.coerceStatementArgument());
  99     }
 100
 101     @Override
 102     protected ActionEffectiveStatement createEffective(
 103             final StmtContext<QName, ActionStatement, ActionEffectiveStatement> ctx, final ActionStatement declared,
 104             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 105         final QName argument = ctx.coerceStatementArgument();
 106         final StatementSourceReference ref = ctx.getStatementSourceReference();
 107         SourceException.throwIf(StmtContextUtils.hasAncestorOfType(ctx, ILLEGAL_PARENTS), ref,
 108             "Action %s is defined within a notification, rpc or another action", argument);
 109         SourceException.throwIf(
 110             !StmtContextUtils.hasAncestorOfTypeWithChildOfType(ctx, YangStmtMapping.LIST, YangStmtMapping.KEY), ref,
 111             "Action %s is defined within a list that has no key statement", argument);
 112         SourceException.throwIf(StmtContextUtils.hasParentOfType(ctx, YangStmtMapping.CASE), ref,
 113             "Action %s is defined within a case statement", argument);
 114         SourceException.throwIf(StmtContextUtils.hasParentOfType(ctx, YangStmtMapping.MODULE), ref,
 115             "Action %s is defined at the top level of a module", argument);
 116
 117         return new ActionEffectiveStatementImpl(declared, ctx.getSchemaPath().get(), computeFlags(ctx, substatements),
 118             ctx, substatements);
 119     }
 120
 121     @Override
 122     protected ActionEffectiveStatement createEmptyEffective(
 123             final StmtContext<QName, ActionStatement, ActionEffectiveStatement> ctx, final ActionStatement declared) {
 124         throw new IllegalStateException("Missing implicit input/output statements at "
 125             + ctx.getStatementSourceReference());
 126     }
 127
 128     private static int computeFlags(final StmtContext<?, ?, ?> ctx,
 129             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 130         return new FlagsBuilder()
 131                 .setHistory(ctx.getCopyHistory())
 132                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 133                 .toFlags();
 134     }
 135
 136 }