Reformulate StatementContextFactory.createEffective()
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / notification / 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.rfc7950.stmt.notification;
9
10 import com.google.common.annotations.Beta;
11 import com.google.common.collect.ImmutableSet;
12 import org.opendaylight.yangtools.yang.common.QName;
13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
14 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
15 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationStatement;
16 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
17 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
18 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
19 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
20 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
21
22 /**
23  * Class providing necessary support for processing YANG 1.1 Notification
24  * statement.
25  */
26 @Beta
27 public final class NotificationStatementRFC7950Support extends AbstractNotificationStatementSupport {
28     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
29             .NOTIFICATION)
30             .addAny(YangStmtMapping.ANYDATA)
31             .addAny(YangStmtMapping.ANYXML)
32             .addAny(YangStmtMapping.CHOICE)
33             .addAny(YangStmtMapping.CONTAINER)
34             .addOptional(YangStmtMapping.DESCRIPTION)
35             .addAny(YangStmtMapping.GROUPING)
36             .addAny(YangStmtMapping.IF_FEATURE)
37             .addAny(YangStmtMapping.LEAF)
38             .addAny(YangStmtMapping.LEAF_LIST)
39             .addAny(YangStmtMapping.LIST)
40             .addAny(YangStmtMapping.MUST)
41             .addOptional(YangStmtMapping.REFERENCE)
42             .addOptional(YangStmtMapping.STATUS)
43             .addAny(YangStmtMapping.TYPEDEF)
44             .addAny(YangStmtMapping.USES)
45             .build();
46
47     private static final ImmutableSet<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(
48             YangStmtMapping.NOTIFICATION, YangStmtMapping.RPC, YangStmtMapping.ACTION);
49     private static final NotificationStatementRFC7950Support INSTANCE = new NotificationStatementRFC7950Support();
50
51     private NotificationStatementRFC7950Support() {
52         // Hidden
53     }
54
55     public static NotificationStatementRFC7950Support getInstance() {
56         return INSTANCE;
57     }
58
59     @Override
60     protected SubstatementValidator getSubstatementValidator() {
61         return SUBSTATEMENT_VALIDATOR;
62     }
63
64
65     @Override
66     void checkEffective(final Current<QName, NotificationStatement> stmt) {
67         final QName argument = stmt.argument();
68         final StatementSourceReference ref = stmt.sourceReference();
69         final var rabbit = stmt.caerbannog();
70         SourceException.throwIf(StmtContextUtils.hasAncestorOfType(rabbit, ILLEGAL_PARENTS), ref,
71             "Notification %s is defined within an rpc, action, or another notification", argument);
72         SourceException.throwIf(
73             !StmtContextUtils.hasAncestorOfTypeWithChildOfType(rabbit, YangStmtMapping.LIST, YangStmtMapping.KEY), ref,
74             "Notification %s is defined within a list that has no key statement", argument);
75         SourceException.throwIf(StmtContextUtils.hasParentOfType(rabbit, YangStmtMapping.CASE), ref,
76             "Notification %s is defined within a case statement", argument);
77     }
78 }