yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/ActionStatementImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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
   9 package org.opendaylight.yangtools.yang.parser.stmt.rfc7950;
  10
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.Collection;
  13 import java.util.Set;
  14 import javax.annotation.Nonnull;
  15 import javax.annotation.Nullable;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  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.ActionStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
  29 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  34 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  35 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.ChildSchemaNodes;
  36 import org.opendaylight.yangtools.yang.parser.stmt.rfc7950.effective.ActionEffectiveStatementImpl;
  37
  38 public class ActionStatementImpl extends AbstractDeclaredStatement<QName> implements ActionStatement {
  39     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  40             YangStmtMapping.ACTION)
  41             .addOptional(YangStmtMapping.DESCRIPTION)
  42             .addAny(YangStmtMapping.GROUPING)
  43             .addAny(YangStmtMapping.IF_FEATURE)
  44             .addOptional(YangStmtMapping.INPUT)
  45             .addOptional(YangStmtMapping.OUTPUT)
  46             .addOptional(YangStmtMapping.REFERENCE)
  47             .addOptional(YangStmtMapping.STATUS)
  48             .addAny(YangStmtMapping.TYPEDEF)
  49             .build();
  50
  51     protected ActionStatementImpl(final StmtContext<QName,ActionStatement, ?> context) {
  52         super(context);
  53     }
  54
  55     public static class Definition
  56             extends AbstractStatementSupport<QName, ActionStatement, EffectiveStatement<QName, ActionStatement>> {
  57
  58         private static final Set<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(YangStmtMapping.NOTIFICATION,
  59                 YangStmtMapping.RPC, YangStmtMapping.ACTION);
  60
  61         public Definition() {
  62             super(YangStmtMapping.ACTION);
  63         }
  64
  65         @Override
  66         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  67             return StmtContextUtils.qnameFromArgument(ctx, value);
  68         }
  69
  70         @Override
  71         public void onStatementAdded(
  72                 final StmtContext.Mutable<QName, ActionStatement, EffectiveStatement<QName, ActionStatement>> stmt) {
  73             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
  74         }
  75
  76         @Override
  77         public ActionStatement createDeclared(
  78                 final StmtContext<QName, ActionStatement, ?> ctx) {
  79             return new ActionStatementImpl(ctx);
  80         }
  81
  82         @Override
  83         public EffectiveStatement<QName, ActionStatement> createEffective(
  84                 final StmtContext<QName, ActionStatement, EffectiveStatement<QName, ActionStatement>> ctx) {
  85             SourceException.throwIf(StmtContextUtils.hasAncestorOfType(ctx, ILLEGAL_PARENTS),
  86                     ctx.getStatementSourceReference(), "Action %s is defined within a notification, rpc or another action",
  87                     ctx.getStatementArgument());
  88             SourceException.throwIf(!StmtContextUtils.hasAncestorOfTypeWithChildOfType(ctx, YangStmtMapping.LIST,
  89                     YangStmtMapping.KEY), ctx.getStatementSourceReference(),
  90                     "Action %s is defined within a list that has no key statement", ctx.getStatementArgument());
  91             SourceException.throwIf(StmtContextUtils.hasParentOfType(ctx, YangStmtMapping.CASE),
  92                     ctx.getStatementSourceReference(), "Action %s is defined within a case statement",
  93                     ctx.getStatementArgument());
  94             SourceException.throwIf(StmtContextUtils.hasParentOfType(ctx, YangStmtMapping.MODULE),
  95                     ctx.getStatementSourceReference(), "Action %s is defined at the top level of a module",
  96                     ctx.getStatementArgument());
  97             return new ActionEffectiveStatementImpl(ctx);
  98         }
  99
 100         @Override
 101         protected SubstatementValidator getSubstatementValidator() {
 102             return SUBSTATEMENT_VALIDATOR;
 103         }
 104     }
 105
 106     @Override
 107     public QName getName() {
 108         return argument();
 109     }
 110
 111     @Nonnull
 112     @Override
 113     public Collection<? extends TypedefStatement> getTypedefs() {
 114         return allDeclared(TypedefStatement.class);
 115     }
 116
 117     @Nonnull
 118     @Override
 119     public Collection<? extends GroupingStatement> getGroupings() {
 120         return allDeclared(GroupingStatement.class);
 121     }
 122
 123     @Nullable
 124     @Override
 125     public StatusStatement getStatus() {
 126         return firstDeclared(StatusStatement.class);
 127     }
 128
 129     @Nullable
 130     @Override
 131     public DescriptionStatement getDescription() {
 132         return firstDeclared(DescriptionStatement.class);
 133     }
 134
 135     @Nullable
 136     @Override
 137     public ReferenceStatement getReference() {
 138         return firstDeclared(ReferenceStatement.class);
 139     }
 140
 141     @Override
 142     public InputStatement getInput() {
 143         return firstDeclared(InputStatement.class);
 144     }
 145
 146     @Override
 147     public OutputStatement getOutput() {
 148         return firstDeclared(OutputStatement.class);
 149     }
 150
 151     @Nonnull
 152     @Override
 153     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 154         return allDeclared(IfFeatureStatement.class);
 155     }
 156 }