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