2a20d072b4051e94f9b09eb6442a297f2a2b7599
[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.ActionStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.MaxElementsStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.MinElementsStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
31 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
32 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueStatement;
33 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
34 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
39 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ListEffectiveStatementImpl;
40
41 public class ListStatementImpl extends AbstractDeclaredStatement<QName>
42         implements ListStatement {
43     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
44             .LIST)
45             .addAny(YangStmtMapping.ANYXML)
46             .addAny(YangStmtMapping.CHOICE)
47             .addOptional(YangStmtMapping.CONFIG)
48             .addAny(YangStmtMapping.CONTAINER)
49             .addOptional(YangStmtMapping.DESCRIPTION)
50             .addAny(YangStmtMapping.GROUPING)
51             .addAny(YangStmtMapping.IF_FEATURE)
52             .addOptional(YangStmtMapping.KEY)
53             .addAny(YangStmtMapping.LEAF)
54             .addAny(YangStmtMapping.LEAF_LIST)
55             .addAny(YangStmtMapping.LIST)
56             .addOptional(YangStmtMapping.MAX_ELEMENTS)
57             .addOptional(YangStmtMapping.MIN_ELEMENTS)
58             .addAny(YangStmtMapping.MUST)
59             .addOptional(YangStmtMapping.ORDERED_BY)
60             .addOptional(YangStmtMapping.REFERENCE)
61             .addOptional(YangStmtMapping.STATUS)
62             .addAny(YangStmtMapping.TYPEDEF)
63             .addAny(YangStmtMapping.UNIQUE)
64             .addAny(YangStmtMapping.USES)
65             .addOptional(YangStmtMapping.WHEN)
66             .build();
67
68     protected ListStatementImpl(final StmtContext<QName, ListStatement, ?> context) {
69         super(context);
70     }
71
72     public static class Definition
73             extends
74             AbstractStatementSupport<QName, ListStatement, EffectiveStatement<QName, ListStatement>> {
75
76         public Definition() {
77             super(YangStmtMapping.LIST);
78         }
79
80         @Override
81         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
82             return Utils.qNameFromArgument(ctx, value);
83         }
84
85         @Override
86         public void onStatementAdded(final Mutable<QName, ListStatement, EffectiveStatement<QName, ListStatement>> stmt) {
87             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
88         }
89
90         @Override
91         public ListStatement createDeclared(
92                 final StmtContext<QName, ListStatement, ?> ctx) {
93             return new ListStatementImpl(ctx);
94         }
95
96         @Override
97         public EffectiveStatement<QName, ListStatement> createEffective(
98                 final StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
99             return new ListEffectiveStatementImpl(ctx);
100         }
101
102         @Override
103         protected SubstatementValidator getSubstatementValidator() {
104             return SUBSTATEMENT_VALIDATOR;
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
199     @Nonnull
200     @Override
201     public Collection<? extends ActionStatement> getActions() {
202         return allDeclared(ActionStatement.class);
203     }
204
205     @Override
206     public final Collection<? extends NotificationStatement> getNotifications() {
207         return allDeclared(NotificationStatement.class);
208     }
209 }