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

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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;
   9
  10 import java.util.Optional;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.common.Revision;
  13 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  14
  15 /**
  16  * Interface describing YANG 'import' statement. The import statement makes definitions from one module available inside
  17  * another module or submodule.
  18  */
  19 // FIXME: 7.0.0: this class is a leak of the declared world into the effective one. In effective world, all nodes form
  20 //               a tree, which consists of multiple (mostly) QName-navigated namespaces. As such module imports
  21 //               contribute only a prefix/QNameModule mapping to the effective world and hence should be mapped that
  22 //               way:
  23 //               - Module exposes String->QNameModule mapping
  24 public interface ModuleImport extends DocumentedNode, EffectiveStatementEquivalent<ImportEffectiveStatement> {
  25     /**
  26      * Returns the name of the module to import.
  27      *
  28      * @return Name of the module to import
  29      */
  30     default @NonNull String getModuleName() {
  31         return asEffectiveStatement().argument().getLocalName();
  32     }
  33
  34     /**
  35      * Returns the module revision to import. May be null.
  36      *
  37      * @return Revision of module to import
  38      */
  39     Optional<Revision> getRevision();
  40
  41     /**
  42      * Returns the prefix associated with the imported module.
  43      *
  44      * @return Prefix used to point to imported module
  45      */
  46     @NonNull String getPrefix();
  47 }