Propagate @Nonnull and @Nullable annotations
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / RpcStatementImpl.java
1 /*
2  * Copyright (c) 2015 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.rfc6020;
9
10 import java.util.Collection;
11 import javax.annotation.Nonnull;
12 import javax.annotation.Nullable;
13 import org.opendaylight.yangtools.yang.common.QName;
14 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
16 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.RpcStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
25 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
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.stmt.rfc6020.effective.RpcEffectiveStatementImpl;
31
32 public class RpcStatementImpl extends AbstractDeclaredStatement<QName>
33         implements RpcStatement {
34     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
35             .RPC)
36             .addOptional(Rfc6020Mapping.DESCRIPTION)
37             .addAny(Rfc6020Mapping.GROUPING)
38             .addAny(Rfc6020Mapping.IF_FEATURE)
39             .addOptional(Rfc6020Mapping.INPUT)
40             .addOptional(Rfc6020Mapping.OUTPUT)
41             .addOptional(Rfc6020Mapping.REFERENCE)
42             .addOptional(Rfc6020Mapping.STATUS)
43             .addAny(Rfc6020Mapping.TYPEDEF)
44             .build();
45
46     protected RpcStatementImpl(final StmtContext<QName, RpcStatement, ?> context) {
47         super(context);
48     }
49
50     public static class Definition
51             extends
52             AbstractStatementSupport<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> {
53
54         public Definition() {
55             super(Rfc6020Mapping.RPC);
56         }
57
58         @Override
59         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
60             return Utils.qNameFromArgument(ctx, value);
61         }
62
63         @Override
64         public void onStatementAdded(final Mutable<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> stmt) {
65             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
66         }
67
68         @Override
69         public RpcStatement createDeclared(
70                 final StmtContext<QName, RpcStatement, ?> ctx) {
71             return new RpcStatementImpl(ctx);
72         }
73
74         @Override
75         public EffectiveStatement<QName, RpcStatement> createEffective(
76                 final StmtContext<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> ctx) {
77             return new RpcEffectiveStatementImpl(ctx);
78         }
79
80         @Override
81         public void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, EffectiveStatement<QName, RpcStatement>> stmt) {
82             super.onFullDefinitionDeclared(stmt);
83             SUBSTATEMENT_VALIDATOR.validate(stmt);
84         }
85     }
86
87     @Override
88     public QName getName() {
89         return argument();
90     }
91
92     @Nonnull
93     @Override
94     public Collection<? extends TypedefStatement> getTypedefs() {
95         return allDeclared(TypedefStatement.class);
96     }
97
98     @Nonnull
99     @Override
100     public Collection<? extends GroupingStatement> getGroupings() {
101         return allDeclared(GroupingStatement.class);
102     }
103
104     @Nullable
105     @Override
106     public StatusStatement getStatus() {
107         return firstDeclared(StatusStatement.class);
108     }
109
110     @Nullable
111     @Override
112     public DescriptionStatement getDescription() {
113         return firstDeclared(DescriptionStatement.class);
114     }
115
116     @Nullable
117     @Override
118     public ReferenceStatement getReference() {
119         return firstDeclared(ReferenceStatement.class);
120     }
121
122     @Override
123     public InputStatement getInput() {
124         return firstDeclared(InputStatement.class);
125     }
126
127     @Override
128     public OutputStatement getOutput() {
129         return firstDeclared(OutputStatement.class);
130     }
131
132     @Nonnull
133     @Override
134     public Collection<? extends IfFeatureStatement> getIfFeatures() {
135         return allDeclared(IfFeatureStatement.class);
136     }
137 }