2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.model.api.stmt;
10 import com.google.common.annotations.Beta;
11 import java.util.Optional;
12 import org.eclipse.jdt.annotation.NonNull;
13 import org.opendaylight.yangtools.yang.common.QNameModule;
14 import org.opendaylight.yangtools.yang.common.SchemaNodeIdentifier;
15 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
17 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
18 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
21 * Effective view of a {@link ModuleStatement}.
24 public interface ModuleEffectiveStatement
25 extends DataTreeAwareEffectiveStatement<Unqualified, ModuleStatement>, SchemaTreeRoot {
27 * Namespace mapping all known prefixes in a module to their modules. Note this namespace includes the module
28 * in which it is instantiated.
30 abstract class PrefixToEffectiveModuleNamespace
31 extends IdentifierNamespace<String, @NonNull ModuleEffectiveStatement> {
32 private PrefixToEffectiveModuleNamespace() {
33 // This class should never be subclassed
38 * Namespace mapping all known {@link QNameModule}s to their encoding prefixes. This includes the declaration
39 * from prefix/namespace/revision and all imports as they were resolved.
41 abstract class QNameModuleToPrefixNamespace extends IdentifierNamespace<QNameModule, @NonNull String> {
42 private QNameModuleToPrefixNamespace() {
43 // This class should never be subclassed
48 * Namespace mapping all included submodules. The namespaces is keyed by submodule name.
50 abstract class NameToEffectiveSubmoduleNamespace
51 extends IdentifierNamespace<String, @NonNull SubmoduleEffectiveStatement> {
52 private NameToEffectiveSubmoduleNamespace() {
53 // This class should never be subclassed
58 default StatementDefinition statementDefinition() {
59 return YangStmtMapping.MODULE;
63 * Get the local QNameModule of this module. All implementations need to override this default method.
65 * @return Local QNameModule
67 @NonNull QNameModule localQNameModule();
73 * Default implementation defers to {@link #findSchemaTreeNode(java.util.List)}.
76 default Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(final SchemaNodeIdentifier path) {
77 return findSchemaTreeNode(path.getNodeIdentifiers());