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