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