2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.stmt.reactor;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
12 import static com.google.common.base.Verify.verify;
13 import static java.util.Objects.requireNonNull;
15 import com.google.common.collect.ImmutableList;
16 import com.google.common.collect.ImmutableSet;
17 import java.util.ArrayList;
18 import java.util.Collection;
19 import java.util.HashSet;
20 import java.util.List;
22 import java.util.Optional;
24 import javax.annotation.Nonnull;
25 import javax.annotation.Nullable;
26 import org.opendaylight.yangtools.yang.common.YangVersion;
27 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
28 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
29 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
31 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
37 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
38 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
41 * Root statement class for a YANG source. All statements defined in that YANG source are mapped underneath an instance
42 * of this class, hence recursive lookups from them cross this class.
44 public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
45 StatementContextBase<A, D, E> {
47 public static final YangVersion DEFAULT_VERSION = YangVersion.VERSION_1;
49 private final SourceSpecificContext sourceContext;
50 private final A argument;
52 private YangVersion rootVersion;
53 private Set<SourceIdentifier> requiredSources = ImmutableSet.of();
54 private SourceIdentifier rootIdentifier;
57 * References to RootStatementContext of submodules which are included in this source.
59 private List<RootStatementContext<?, ?, ?>> includedContexts = ImmutableList.of();
61 RootStatementContext(final SourceSpecificContext sourceContext, final StatementDefinitionContext<A, D, E> def,
62 final StatementSourceReference ref, final String rawArgument) {
63 super(def, ref, rawArgument);
64 this.sourceContext = requireNonNull(sourceContext);
65 this.argument = def.parseArgumentValue(this, rawStatementArgument());
68 RootStatementContext(final SourceSpecificContext sourceContext, final StatementDefinitionContext<A, D, E> def,
69 final StatementSourceReference ref, final String rawArgument, final YangVersion version,
70 final SourceIdentifier identifier) {
71 this(sourceContext, def, ref, rawArgument);
72 this.setRootVersion(version);
73 this.setRootIdentifier(identifier);
77 public StatementContextBase<?, ?, ?> getParentContext() {
78 // null as root cannot have parent
83 public NamespaceStorageNode getParentNamespaceStorage() {
84 // namespace storage of source context
89 public Registry getBehaviourRegistry() {
94 public StorageNodeType getStorageNodeType() {
95 return StorageNodeType.ROOT_STATEMENT_LOCAL;
100 public RootStatementContext<?, ?, ?> getRoot() {
101 // this as its own root
105 SourceSpecificContext getSourceContext() {
106 return sourceContext;
110 public A getStatementArgument() {
116 public Optional<SchemaPath> getSchemaPath() {
117 return Optional.of(SchemaPath.ROOT);
121 public boolean isConfiguration() {
126 public boolean isEnabledSemanticVersioning() {
127 return sourceContext.isEnabledSemanticVersioning();
131 public <K, V, N extends IdentifierNamespace<K, V>> V putToLocalStorage(final Class<N> type, final K key,
133 if (IncludedModuleContext.class.isAssignableFrom(type)) {
134 if (includedContexts.isEmpty()) {
135 includedContexts = new ArrayList<>(1);
137 verify(value instanceof RootStatementContext);
138 includedContexts.add((RootStatementContext<?, ?, ?>) value);
140 return super.putToLocalStorage(type, key, value);
145 public <K, V, N extends IdentifierNamespace<K, V>> V getFromLocalStorage(final Class<N> type, final K key) {
146 return getFromLocalStorage(type, key, new HashSet<>());
150 * We need to track already checked RootStatementContexts due to possible
151 * circular chains of includes between submodules
154 private <K, V, N extends IdentifierNamespace<K, V>> V getFromLocalStorage(final Class<N> type, final K key,
155 final HashSet<RootStatementContext<?, ?, ?>> alreadyChecked) {
156 final V potentialLocal = super.getFromLocalStorage(type, key);
157 if (potentialLocal != null) {
158 return potentialLocal;
161 alreadyChecked.add(this);
162 for (final RootStatementContext<?, ?, ?> includedSource : includedContexts) {
163 if (alreadyChecked.contains(includedSource)) {
166 final V potential = includedSource.getFromLocalStorage(type, key, alreadyChecked);
167 if (potential != null) {
176 public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type) {
177 return getAllFromLocalStorage(type, new HashSet<>());
181 * We need to track already checked RootStatementContexts due to possible
182 * circular chains of includes between submodules
185 private <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type,
186 final HashSet<RootStatementContext<?, ?, ?>> alreadyChecked) {
187 final Map<K, V> potentialLocal = super.getAllFromLocalStorage(type);
188 if (potentialLocal != null) {
189 return potentialLocal;
192 alreadyChecked.add(this);
193 for (final RootStatementContext<?, ?, ?> includedSource : includedContexts) {
194 if (alreadyChecked.contains(includedSource)) {
197 final Map<K, V> potential = includedSource.getAllFromLocalStorage(type, alreadyChecked);
198 if (potential != null) {
206 public YangVersion getRootVersion() {
207 return rootVersion == null ? DEFAULT_VERSION : rootVersion;
211 public void setRootVersion(final YangVersion version) {
212 checkArgument(sourceContext.getSupportedVersions().contains(version),
213 "Unsupported yang version %s in %s", version, getStatementSourceReference());
214 checkState(this.rootVersion == null, "Version of root %s has been already set to %s", argument,
216 this.rootVersion = requireNonNull(version);
220 public void addMutableStmtToSeal(final MutableStatement mutableStatement) {
221 sourceContext.addMutableStmtToSeal(mutableStatement);
225 public void addRequiredSource(final SourceIdentifier dependency) {
226 checkState(sourceContext.getInProgressPhase() == ModelProcessingPhase.SOURCE_PRE_LINKAGE,
227 "Add required module is allowed only in ModelProcessingPhase.SOURCE_PRE_LINKAGE phase");
228 if (requiredSources.isEmpty()) {
229 requiredSources = new HashSet<>();
231 requiredSources.add(dependency);
235 * Return the set of required sources.
237 * @return Required sources.
239 Collection<SourceIdentifier> getRequiredSources() {
240 return ImmutableSet.copyOf(requiredSources);
244 public void setRootIdentifier(final SourceIdentifier identifier) {
245 this.rootIdentifier = requireNonNull(identifier);
248 SourceIdentifier getRootIdentifier() {
249 return rootIdentifier;
253 protected boolean isIgnoringIfFeatures() {
258 protected boolean isIgnoringConfig() {
263 protected boolean isParentSupportedByFeatures() {