Add a proper grouping statement policy
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / list / AbstractListEffectiveStatement.java
1 /*
2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.rfc7950.stmt.list;
9
10 import com.google.common.collect.ImmutableList;
11 import java.util.Collection;
12 import java.util.List;
13 import org.eclipse.jdt.annotation.NonNull;
14 import org.eclipse.jdt.annotation.Nullable;
15 import org.opendaylight.yangtools.yang.common.QName;
16 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
17 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
18 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
19 import org.opendaylight.yangtools.yang.model.api.SchemaNodeDefaults;
20 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueEffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.compat.ActionNodeContainerCompat;
26 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
27 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredEffectiveStatement.DefaultWithDataTree;
28 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.ActionNodeContainerMixin;
29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.AugmentationTargetMixin;
30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DataNodeContainerMixin;
31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DataSchemaNodeMixin;
32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.MustConstraintMixin;
33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.NotificationNodeContainerMixin;
34 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.UserOrderedMixin;
35 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.WhenConditionMixin;
36
37 abstract class AbstractListEffectiveStatement
38         extends DefaultWithDataTree<QName, ListStatement, ListEffectiveStatement>
39         implements ListEffectiveStatement, ListSchemaNode, DerivableSchemaNode,
40             ActionNodeContainerCompat<QName, ListStatement, ListEffectiveStatement>,
41             NotificationNodeContainerCompat<QName, ListStatement, ListEffectiveStatement>,
42             DataSchemaNodeMixin<QName, ListStatement>, UserOrderedMixin<QName, ListStatement>,
43             DataNodeContainerMixin<QName, ListStatement>, WhenConditionMixin<QName, ListStatement>,
44             AugmentationTargetMixin<QName, ListStatement>, NotificationNodeContainerMixin<QName, ListStatement>,
45             ActionNodeContainerMixin<QName, ListStatement>, MustConstraintMixin<QName, ListStatement> {
46     private final int flags;
47     private final @NonNull Object substatements;
48     private final @Nullable SchemaPath path;
49     private final @NonNull Object keyDefinition;
50
51     AbstractListEffectiveStatement(final ListStatement declared, final SchemaPath path, final int flags,
52             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements,
53             final ImmutableList<QName> keyDefinition) {
54         super(declared, substatements);
55
56         this.substatements = maskList(substatements);
57         this.path = path;
58         this.keyDefinition = maskList(keyDefinition);
59         this.flags = flags;
60     }
61
62     @Override
63     public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
64         return unmaskList(substatements);
65     }
66
67     @Override
68     public final int flags() {
69         return flags;
70     }
71
72     @Override
73     public final QName argument() {
74         return getQName();
75     }
76
77     @Override
78     @Deprecated
79     public final SchemaPath getPath() {
80         return SchemaNodeDefaults.throwUnsupportedIfNull(this, path);
81     }
82
83     @Override
84     public final boolean isUserOrdered() {
85         return userOrdered();
86     }
87
88     @Override
89     public final List<QName> getKeyDefinition() {
90         return unmaskList(keyDefinition, QName.class);
91     }
92
93     @Override
94     public final DataSchemaNode dataChildByName(final QName name) {
95         return dataSchemaNode(name);
96     }
97
98     @Override
99     public final Collection<? extends UniqueEffectiveStatement> getUniqueConstraints() {
100         return effectiveSubstatements().stream()
101                 .filter(UniqueEffectiveStatement.class::isInstance)
102                 .map(UniqueEffectiveStatement.class::cast)
103                 .collect(ImmutableList.toImmutableList());
104     }
105
106     @Override
107     public final ListEffectiveStatement asEffectiveStatement() {
108         return this;
109     }
110
111     @Override
112     public final String toString() {
113         return "list " + getQName().getLocalName();
114     }
115 }