BUG-6497: Do not lose augmentation statement order
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / effective / UsesEffectiveStatementImpl.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.effective;
9
10 import com.google.common.base.Optional;
11 import com.google.common.collect.ImmutableList;
12 import com.google.common.collect.ImmutableMap;
13 import com.google.common.collect.ImmutableSet;
14 import java.util.Collection;
15 import java.util.HashMap;
16 import java.util.LinkedHashSet;
17 import java.util.LinkedList;
18 import java.util.List;
19 import java.util.Map;
20 import java.util.Objects;
21 import java.util.Set;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
24 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
25 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
27 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.UsesNode;
29 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
31 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
32 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
33 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.TypeOfCopy;
36
37 public final class UsesEffectiveStatementImpl extends AbstractEffectiveDocumentedNode<QName, UsesStatement> implements UsesNode {
38     private final SchemaPath groupingPath;
39     private final boolean addedByUses;
40     private final Map<SchemaPath, SchemaNode> refines;
41     private final Set<AugmentationSchema> augmentations;
42     private final List<UnknownSchemaNode> unknownNodes;
43     private final RevisionAwareXPath whenCondition;
44
45     public UsesEffectiveStatementImpl(
46             final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
47         super(ctx);
48
49         // initGroupingPath
50         final StmtContext<?, GroupingStatement, EffectiveStatement<QName, GroupingStatement>> grpCtx = ctx.getFromNamespace(
51                 GroupingNamespace.class, ctx.getStatementArgument());
52         this.groupingPath = grpCtx.getSchemaPath().get();
53
54         // initCopyType
55         final List<TypeOfCopy> copyTypesFromOriginal = ctx.getCopyHistory();
56         if (copyTypesFromOriginal.contains(TypeOfCopy.ADDED_BY_USES)) {
57             addedByUses = true;
58         } else {
59             addedByUses = false;
60         }
61
62         // initSubstatementCollections
63         final Collection<? extends EffectiveStatement<?, ?>> effectiveSubstatements = effectiveSubstatements();
64         final List<UnknownSchemaNode> unknownNodesInit = new LinkedList<>();
65         final Set<AugmentationSchema> augmentationsInit = new LinkedHashSet<>();
66         final Map<SchemaPath, SchemaNode> refinesInit = new HashMap<>();
67         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements) {
68             if (effectiveStatement instanceof UnknownSchemaNode) {
69                 final UnknownSchemaNode unknownNode = (UnknownSchemaNode) effectiveStatement;
70                 unknownNodesInit.add(unknownNode);
71             }
72             if (effectiveStatement instanceof AugmentationSchema) {
73                 final AugmentationSchema augmentationSchema = (AugmentationSchema) effectiveStatement;
74                 augmentationsInit.add(augmentationSchema);
75             }
76             if (effectiveStatement instanceof RefineEffectiveStatementImpl) {
77                 final RefineEffectiveStatementImpl refineStmt = (RefineEffectiveStatementImpl) effectiveStatement;
78                 final SchemaNodeIdentifier identifier = refineStmt.argument();
79                 refinesInit.put(identifier.asSchemaPath(), refineStmt.getRefineTargetNode());
80             }
81         }
82         this.unknownNodes = ImmutableList.copyOf(unknownNodesInit);
83         this.augmentations = ImmutableSet.copyOf(augmentationsInit);
84         this.refines = ImmutableMap.copyOf(refinesInit);
85
86         final WhenEffectiveStatementImpl whenStmt = firstEffective(WhenEffectiveStatementImpl.class);
87         this.whenCondition = (whenStmt == null) ? null : whenStmt.argument();
88     }
89
90     @Override
91     public SchemaPath getGroupingPath() {
92         return groupingPath;
93     }
94
95     @Override
96     public Set<AugmentationSchema> getAugmentations() {
97         return augmentations;
98     }
99
100     @Override
101     public boolean isAugmenting() {
102         return false;
103     }
104
105     @Override
106     public boolean isAddedByUses() {
107         return addedByUses;
108     }
109
110     @Override
111     public Map<SchemaPath, SchemaNode> getRefines() {
112         return refines;
113     }
114
115     @Override
116     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
117         return unknownNodes;
118     }
119
120     @Override
121     public Optional<RevisionAwareXPath> getWhenCondition() {
122         return Optional.fromNullable(whenCondition);
123     }
124
125     @Override
126     public int hashCode() {
127         final int prime = 31;
128         int result = 1;
129         result = prime * result + Objects.hashCode(groupingPath);
130         result = prime * result + Objects.hashCode(augmentations);
131         return result;
132     }
133
134     @Override
135     public boolean equals(final Object obj) {
136         if (this == obj) {
137             return true;
138         }
139         if (obj == null) {
140             return false;
141         }
142         if (getClass() != obj.getClass()) {
143             return false;
144         }
145         final UsesEffectiveStatementImpl other = (UsesEffectiveStatementImpl) obj;
146         return Objects.equals(groupingPath, other.groupingPath) && Objects.equals(augmentations, other.augmentations);
147     }
148
149     @Override
150     public String toString() {
151         return UsesEffectiveStatementImpl.class.getSimpleName() + "[groupingPath=" +
152                 groupingPath +
153                 "]";
154     }
155 }