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