yang/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 org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.common.QNameModule;
  13 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  14 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  15
  16 /**
  17  * Effective view of a {@link ModuleStatement}.
  18  */
  19 @Beta
  20 // FIXME: 3.0.0: we should reshuffle the String here, as module name is in reality a YANG identifier, e.g. not just
  21 //               an ordinary String. We really want this to be a QName, so that we do not need the localQNameModule
  22 //               bit, but that may be problematic with ModuleStatement, which is getting created before we even know
  23 //               the namespace :( A type capture of the string may just be sufficient.
  24 public interface ModuleEffectiveStatement extends EffectiveStatement<String, ModuleStatement> {
  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             implements 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 implements 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             implements IdentifierNamespace<String, @NonNull SubmoduleEffectiveStatement> {
  51         private NameToEffectiveSubmoduleNamespace() {
  52             // This class should never be subclassed
  53         }
  54     }
  55
  56     /**
  57      * Get the local QNameModule of this module. All implementations need to override this default method.
  58      *
  59      * @return Local QNameModule
  60      */
  61     // FIXME: 3.0.0 make this method non-default.
  62     default @NonNull QNameModule localQNameModule() {
  63         throw new UnsupportedOperationException(getClass() + " is missing an implementation");
  64     }
  65 }