yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc7950/NotificationStatementRfc7950Support.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 package org.opendaylight.yangtools.yang.parser.stmt.rfc7950;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.Set;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationStatement;
  18 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  19 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  20 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  21 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  22 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.NotificationStatementImpl;
  23 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.NotificationEffectiveStatementImpl;
  24
  25 /**
  26  * Class providing necessary support for processing YANG 1.1 Notification
  27  * statement.
  28  */
  29 @Beta
  30 public final class NotificationStatementRfc7950Support extends NotificationStatementImpl.Definition {
  31     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  32             .NOTIFICATION)
  33             .addAny(YangStmtMapping.ANYDATA)
  34             .addAny(YangStmtMapping.ANYXML)
  35             .addAny(YangStmtMapping.CHOICE)
  36             .addAny(YangStmtMapping.CONTAINER)
  37             .addOptional(YangStmtMapping.DESCRIPTION)
  38             .addAny(YangStmtMapping.GROUPING)
  39             .addAny(YangStmtMapping.IF_FEATURE)
  40             .addAny(YangStmtMapping.LEAF)
  41             .addAny(YangStmtMapping.LEAF_LIST)
  42             .addAny(YangStmtMapping.LIST)
  43             .addOptional(YangStmtMapping.REFERENCE)
  44             .addOptional(YangStmtMapping.STATUS)
  45             .addAny(YangStmtMapping.TYPEDEF)
  46             .addAny(YangStmtMapping.USES)
  47             .build();
  48
  49     // :FIXME add action statement to the set of illegal parents, once bug-6896
  50     // will be resolved.
  51     private static final Set<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(YangStmtMapping.NOTIFICATION,
  52             YangStmtMapping.RPC);
  53
  54     @Override
  55     public EffectiveStatement<QName, NotificationStatement> createEffective(
  56             final StmtContext<QName, NotificationStatement, EffectiveStatement<QName, NotificationStatement>> ctx) {
  57         SourceException
  58                 .throwIf(StmtContextUtils.hasAncestorOfType(ctx, ILLEGAL_PARENTS), ctx.getStatementSourceReference(),
  59                         "Notification %s is defined within an rpc, action, or another notification",
  60                         ctx.getStatementArgument());
  61         SourceException.throwIf(!StmtContextUtils.hasAncestorOfTypeWithChildOfType(ctx, YangStmtMapping.LIST,
  62                 YangStmtMapping.KEY), ctx.getStatementSourceReference(),
  63                 "Notification %s is defined within a list that has no key statement", ctx.getStatementArgument());
  64         SourceException.throwIf(StmtContextUtils.hasParentOfType(ctx, YangStmtMapping.CASE), ctx.getStatementSourceReference(),
  65                 "Notification %s is defined within a case statement", ctx.getStatementArgument());
  66         return new NotificationEffectiveStatementImpl(ctx);
  67     }
  68
  69     @Override
  70     protected SubstatementValidator getSubstatementValidator() {
  71         return SUBSTATEMENT_VALIDATOR;
  72     }
  73 }