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 @Beta
  17 public interface ModuleEffectiveStatement extends EffectiveStatement<String, ModuleStatement> {
  18     /**
  19      * Namespace mapping all known prefixes in a module to their modules. Note this namespace includes the module
  20      * in which it is instantiated.
  21      */
  22     abstract class PrefixToEffectiveModuleNamespace
  23             implements IdentifierNamespace<String, @NonNull ModuleEffectiveStatement> {
  24         private PrefixToEffectiveModuleNamespace() {
  25             // This class should never be subclassed
  26         }
  27     }
  28
  29     /**
  30      * Namespace mapping all known {@link QNameModule}s to their encoding prefixes. This includes the declaration
  31      * from prefix/namespace/revision and all imports as they were resolved.
  32      */
  33     abstract class QNameModuleToPrefixNamespace implements IdentifierNamespace<QNameModule, @NonNull String> {
  34         private QNameModuleToPrefixNamespace() {
  35             // This class should never be subclassed
  36         }
  37     }
  38
  39     /**
  40      * Get the local QNameModule of this module. All implementations need to override this default method.
  41      *
  42      * @return Local QNameModule
  43      */
  44     // FIXME: 3.0.0 make this method non-default
  45     default @NonNull QNameModule localQNameModule() {
  46         throw new UnsupportedOperationException(getClass() + " is missing an implementation");
  47     }
  48 }