BUG-6497: Do not lose augmentation statement order
[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.stmt.rfc6020.effective.ListEffectiveStatementImpl;
40
41 public class ListStatementImpl extends AbstractDeclaredStatement<QName>
42         implements ListStatement {
43     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
44             .LIST)
45             .add(Rfc6020Mapping.ANYXML, 0, MAX)
46             .add(Rfc6020Mapping.CHOICE, 0, MAX)
47             .add(Rfc6020Mapping.CONFIG, 0, 1)
48             .add(Rfc6020Mapping.CONTAINER, 0, MAX)
49             .add(Rfc6020Mapping.DESCRIPTION, 0, 1)
50             .add(Rfc6020Mapping.GROUPING, 0, MAX)
51             .add(Rfc6020Mapping.IF_FEATURE, 0, MAX)
52             .add(Rfc6020Mapping.KEY, 0, 1)
53             .add(Rfc6020Mapping.LEAF, 0, MAX)
54             .add(Rfc6020Mapping.LEAF_LIST, 0, MAX)
55             .add(Rfc6020Mapping.LIST, 0, MAX)
56             .add(Rfc6020Mapping.MAX_ELEMENTS, 0, 1)
57             .add(Rfc6020Mapping.MIN_ELEMENTS, 0, 1)
58             .add(Rfc6020Mapping.MUST, 0, MAX)
59             .add(Rfc6020Mapping.ORDERED_BY, 0, 1)
60             .add(Rfc6020Mapping.REFERENCE, 0, 1)
61             .add(Rfc6020Mapping.STATUS, 0, 1)
62             .add(Rfc6020Mapping.TYPEDEF, 0, MAX)
63             .add(Rfc6020Mapping.UNIQUE, 0, MAX)
64             .add(Rfc6020Mapping.USES, 0, MAX)
65             .add(Rfc6020Mapping.WHEN, 0, 1)
66             .build();
67
68     protected ListStatementImpl(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(Rfc6020Mapping.LIST);
78         }
79
80         @Override
81         public QName parseArgumentValue(StmtContext<?, ?, ?> ctx, String value) {
82             return Utils.qNameFromArgument(ctx, value);
83         }
84
85         @Override
86         public void onStatementAdded(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                 StmtContext<QName, ListStatement, ?> ctx) {
93             return new ListStatementImpl(ctx);
94         }
95
96         @Override
97         public EffectiveStatement<QName, ListStatement> createEffective(
98                 StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
99             return new ListEffectiveStatementImpl(ctx);
100         }
101
102         @Override
103         public void onFullDefinitionDeclared(Mutable<QName, ListStatement,
104                 EffectiveStatement<QName, ListStatement>> stmt) {
105             super.onFullDefinitionDeclared(stmt);
106             SUBSTATEMENT_VALIDATOR.validate(stmt);
107         }
108     }
109
110     @Nonnull
111     @Override
112     public QName getName() {
113         return argument();
114     }
115
116     @Nullable
117     @Override
118     public ConfigStatement getConfig() {
119         return firstDeclared(ConfigStatement.class);
120     }
121
122     @Override
123     public WhenStatement getWhenStatement() {
124         return firstDeclared(WhenStatement.class);
125     }
126
127     @Nonnull
128     @Override
129     public Collection<? extends IfFeatureStatement> getIfFeatures() {
130         return allDeclared(IfFeatureStatement.class);
131     }
132
133     @Nullable
134     @Override
135     public StatusStatement getStatus() {
136         return firstDeclared(StatusStatement.class);
137     }
138
139     @Nullable
140     @Override
141     public DescriptionStatement getDescription() {
142         return firstDeclared(DescriptionStatement.class);
143     }
144
145     @Nullable
146     @Override
147     public ReferenceStatement getReference() {
148         return firstDeclared(ReferenceStatement.class);
149     }
150
151     @Override
152     public MinElementsStatement getMinElements() {
153         return firstDeclared(MinElementsStatement.class);
154     }
155
156     @Override
157     public MaxElementsStatement getMaxElements() {
158         return firstDeclared(MaxElementsStatement.class);
159     }
160
161     @Override
162     public OrderedByStatement getOrderedBy() {
163         return firstDeclared(OrderedByStatement.class);
164     }
165
166     @Override
167     public Collection<? extends TypedefStatement> getTypedefs() {
168         return allDeclared(TypedefStatement.class);
169     }
170
171     @Override
172     public Collection<? extends GroupingStatement> getGroupings() {
173         return allDeclared(GroupingStatement.class);
174     }
175
176     @Override
177     public Collection<? extends DataDefinitionStatement> getDataDefinitions() {
178         return allDeclared(DataDefinitionStatement.class);
179     }
180
181     @Override
182     public Collection<? extends MustStatement> getMusts() {
183         return allDeclared(MustStatement.class);
184     }
185
186     @Override
187     public KeyStatement getKey() {
188         return firstDeclared(KeyStatement.class);
189     }
190
191     @Override
192     public Collection<? extends UniqueStatement> getUnique() {
193         return allDeclared(UniqueStatement.class);
194     }
195 }