model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ModuleEffectiveStatement.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.model.api.stmt;
   9
  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.UnqualifiedQName;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  17 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  18
  19 /**
  20  * Effective view of a {@link ModuleStatement}.
  21  */
  22 @Beta
  23 public interface ModuleEffectiveStatement
  24         extends DataTreeAwareEffectiveStatement<UnqualifiedQName, ModuleStatement>, SchemaTreeRoot {
  25     /**
  26      * Namespace mapping all known prefixes in a module to their modules. Note this namespace includes the module
  27      * in which it is instantiated.
  28      */
  29     abstract class PrefixToEffectiveModuleNamespace
  30             extends IdentifierNamespace<String, @NonNull ModuleEffectiveStatement> {
  31         private PrefixToEffectiveModuleNamespace() {
  32             // This class should never be subclassed
  33         }
  34     }
  35
  36     /**
  37      * Namespace mapping all known {@link QNameModule}s to their encoding prefixes. This includes the declaration
  38      * from prefix/namespace/revision and all imports as they were resolved.
  39      */
  40     abstract class QNameModuleToPrefixNamespace extends IdentifierNamespace<QNameModule, @NonNull String> {
  41         private QNameModuleToPrefixNamespace() {
  42             // This class should never be subclassed
  43         }
  44     }
  45
  46     /**
  47      * Namespace mapping all included submodules. The namespaces is keyed by submodule name.
  48      */
  49     abstract class NameToEffectiveSubmoduleNamespace
  50             extends IdentifierNamespace<String, @NonNull SubmoduleEffectiveStatement> {
  51         private NameToEffectiveSubmoduleNamespace() {
  52             // This class should never be subclassed
  53         }
  54     }
  55
  56     @Override
  57     default StatementDefinition statementDefinition() {
  58         return YangStmtMapping.MODULE;
  59     }
  60
  61     /**
  62      * Get the local QNameModule of this module. All implementations need to override this default method.
  63      *
  64      * @return Local QNameModule
  65      */
  66     @NonNull QNameModule localQNameModule();
  67
  68     /**
  69      * {@inheritDoc}
  70      *
  71      * @implSpec
  72      *     Default implementation defers to {@link #findSchemaTreeNode(java.util.List)}.
  73      */
  74     @Override
  75     default Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(final SchemaNodeIdentifier path) {
  76         return findSchemaTreeNode(path.getNodeIdentifiers());
  77     }
  78 }