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