Propagate @Nonnull and @Nullable annotations
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / ListStatementImpl.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.ConfigStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.MaxElementsStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.MinElementsStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueStatement;
31 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
32 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
37 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ListEffectiveStatementImpl;
38
39 public class ListStatementImpl extends AbstractDeclaredStatement<QName>
40         implements ListStatement {
41     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
42             .LIST)
43             .addAny(Rfc6020Mapping.ANYXML)
44             .addAny(Rfc6020Mapping.CHOICE)
45             .addOptional(Rfc6020Mapping.CONFIG)
46             .addAny(Rfc6020Mapping.CONTAINER)
47             .addOptional(Rfc6020Mapping.DESCRIPTION)
48             .addAny(Rfc6020Mapping.GROUPING)
49             .addAny(Rfc6020Mapping.IF_FEATURE)
50             .addOptional(Rfc6020Mapping.KEY)
51             .addAny(Rfc6020Mapping.LEAF)
52             .addAny(Rfc6020Mapping.LEAF_LIST)
53             .addAny(Rfc6020Mapping.LIST)
54             .addOptional(Rfc6020Mapping.MAX_ELEMENTS)
55             .addOptional(Rfc6020Mapping.MIN_ELEMENTS)
56             .addAny(Rfc6020Mapping.MUST)
57             .addOptional(Rfc6020Mapping.ORDERED_BY)
58             .addOptional(Rfc6020Mapping.REFERENCE)
59             .addOptional(Rfc6020Mapping.STATUS)
60             .addAny(Rfc6020Mapping.TYPEDEF)
61             .addAny(Rfc6020Mapping.UNIQUE)
62             .addAny(Rfc6020Mapping.USES)
63             .addOptional(Rfc6020Mapping.WHEN)
64             .build();
65
66     protected ListStatementImpl(final StmtContext<QName, ListStatement, ?> context) {
67         super(context);
68     }
69
70     public static class Definition
71             extends
72             AbstractStatementSupport<QName, ListStatement, EffectiveStatement<QName, ListStatement>> {
73
74         public Definition() {
75             super(Rfc6020Mapping.LIST);
76         }
77
78         @Override
79         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
80             return Utils.qNameFromArgument(ctx, value);
81         }
82
83         @Override
84         public void onStatementAdded(final Mutable<QName, ListStatement, EffectiveStatement<QName, ListStatement>> stmt) {
85             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
86         }
87
88         @Override
89         public ListStatement createDeclared(
90                 final StmtContext<QName, ListStatement, ?> ctx) {
91             return new ListStatementImpl(ctx);
92         }
93
94         @Override
95         public EffectiveStatement<QName, ListStatement> createEffective(
96                 final StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
97             return new ListEffectiveStatementImpl(ctx);
98         }
99
100         @Override
101         public void onFullDefinitionDeclared(final Mutable<QName, ListStatement,
102                 EffectiveStatement<QName, ListStatement>> stmt) {
103             super.onFullDefinitionDeclared(stmt);
104             SUBSTATEMENT_VALIDATOR.validate(stmt);
105         }
106     }
107
108     @Nonnull
109     @Override
110     public QName getName() {
111         return argument();
112     }
113
114     @Nullable
115     @Override
116     public ConfigStatement getConfig() {
117         return firstDeclared(ConfigStatement.class);
118     }
119
120     @Override
121     public WhenStatement getWhenStatement() {
122         return firstDeclared(WhenStatement.class);
123     }
124
125     @Nonnull
126     @Override
127     public Collection<? extends IfFeatureStatement> getIfFeatures() {
128         return allDeclared(IfFeatureStatement.class);
129     }
130
131     @Nullable
132     @Override
133     public StatusStatement getStatus() {
134         return firstDeclared(StatusStatement.class);
135     }
136
137     @Nullable
138     @Override
139     public DescriptionStatement getDescription() {
140         return firstDeclared(DescriptionStatement.class);
141     }
142
143     @Nullable
144     @Override
145     public ReferenceStatement getReference() {
146         return firstDeclared(ReferenceStatement.class);
147     }
148
149     @Override
150     public MinElementsStatement getMinElements() {
151         return firstDeclared(MinElementsStatement.class);
152     }
153
154     @Override
155     public MaxElementsStatement getMaxElements() {
156         return firstDeclared(MaxElementsStatement.class);
157     }
158
159     @Override
160     public OrderedByStatement getOrderedBy() {
161         return firstDeclared(OrderedByStatement.class);
162     }
163
164     @Nonnull
165     @Override
166     public Collection<? extends TypedefStatement> getTypedefs() {
167         return allDeclared(TypedefStatement.class);
168     }
169
170     @Nonnull
171     @Override
172     public Collection<? extends GroupingStatement> getGroupings() {
173         return allDeclared(GroupingStatement.class);
174     }
175
176     @Nonnull
177     @Override
178     public Collection<? extends DataDefinitionStatement> getDataDefinitions() {
179         return allDeclared(DataDefinitionStatement.class);
180     }
181
182     @Nonnull
183     @Override
184     public Collection<? extends MustStatement> getMusts() {
185         return allDeclared(MustStatement.class);
186     }
187
188     @Override
189     public KeyStatement getKey() {
190         return firstDeclared(KeyStatement.class);
191     }
192
193     @Nonnull
194     @Override
195     public Collection<? extends UniqueStatement> getUnique() {
196         return allDeclared(UniqueStatement.class);
197     }
198 }