Refactor rpc/action statements
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / rpc / AbstractRpcStatementSupport.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.rpc;
9
10 import com.google.common.collect.ImmutableList;
11 import org.opendaylight.yangtools.yang.common.QName;
12 import org.opendaylight.yangtools.yang.model.api.Status;
13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
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.model.api.stmt.RpcEffectiveStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.RpcStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
21 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
22 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
23 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
29 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
30
31 abstract class AbstractRpcStatementSupport extends BaseQNameStatementSupport<RpcStatement, RpcEffectiveStatement> {
32     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
33         YangStmtMapping.RPC)
34         .addOptional(YangStmtMapping.DESCRIPTION)
35         .addAny(YangStmtMapping.GROUPING)
36         .addAny(YangStmtMapping.IF_FEATURE)
37         .addOptional(YangStmtMapping.INPUT)
38         .addOptional(YangStmtMapping.OUTPUT)
39         .addOptional(YangStmtMapping.REFERENCE)
40         .addOptional(YangStmtMapping.STATUS)
41         .addAny(YangStmtMapping.TYPEDEF)
42         .build();
43
44     AbstractRpcStatementSupport() {
45         super(YangStmtMapping.RPC);
46     }
47
48     @Override
49     public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
50         return StmtContextUtils.parseIdentifier(ctx, value);
51     }
52
53     @Override
54     public final void onStatementAdded(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt) {
55         stmt.coerceParentContext().addToNs(ChildSchemaNodeNamespace.class, stmt.coerceStatementArgument(), stmt);
56     }
57
58     @Override
59     public final void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt) {
60         super.onFullDefinitionDeclared(stmt);
61
62         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
63             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implictInput(), null);
64         }
65         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
66             ((StatementContextBase<?, ?, ?>) stmt).appendImplicitSubstatement(implictOutput(), null);
67         }
68     }
69
70     @Override
71     protected final SubstatementValidator getSubstatementValidator() {
72         return SUBSTATEMENT_VALIDATOR;
73     }
74
75     @Override
76     protected final RpcStatement createDeclared(final StmtContext<QName, RpcStatement, ?> ctx,
77             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
78         return new RegularRpcStatement(ctx.coerceStatementArgument(), substatements);
79     }
80
81     @Override
82     protected final RpcStatement createEmptyDeclared(final StmtContext<QName, RpcStatement, ?> ctx) {
83         return new EmptyRpcStatement(ctx.coerceStatementArgument());
84     }
85
86     @Override
87     protected final RpcEffectiveStatement createEffective(
88             final StmtContext<QName, RpcStatement, RpcEffectiveStatement> ctx, final RpcStatement declared,
89             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
90         return new RpcEffectiveStatementImpl(declared, ctx.getSchemaPath().get(), computeFlags(ctx, substatements), ctx,
91             substatements);
92     }
93
94     @Override
95     protected final RpcEffectiveStatement createEmptyEffective(
96             final StmtContext<QName, RpcStatement, RpcEffectiveStatement> ctx, final RpcStatement declared) {
97         throw new IllegalStateException("Missing implicit input/output statements at "
98                 + ctx.getStatementSourceReference());
99     }
100
101     abstract StatementSupport<?, ?, ?> implictInput();
102
103     abstract StatementSupport<?, ?, ?> implictOutput();
104
105     private static int computeFlags(final StmtContext<?, ?, ?> ctx,
106             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
107         return new FlagsBuilder()
108                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
109                 .toFlags();
110     }
111 }