yang/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.opendaylight.yangtools.concepts.SemVer;
  12 import org.opendaylight.yangtools.yang.common.Revision;
  13
  14 /**
  15  * Interface describing YANG 'import' statement.
  16  *
  17  * <p>
  18  * The import statement makes definitions from one module available inside another module or submodule.
  19  */
  20 // FIXME: 5.0.0 this class is a leak of the declared world into the effective one. In effective world, all nodes form
  21 //        a tree, which consists of multiple (mostly) QName-navigated namespaces. As such module imports contribute
  22 //        only a prefix/QNameModule mapping to the effective world and hence should be mapped that way:
  23 //        - Module exposes String->QNameModule mapping
  24 public interface ModuleImport extends DocumentedNode {
  25     /**
  26      * Returns the name of the module to import.
  27      *
  28      * @return Name of the module to import
  29      */
  30     String getModuleName();
  31
  32     /**
  33      * Returns the module revision to import. May be null.
  34      *
  35      * @return Revision of module to import
  36      */
  37     Optional<Revision> getRevision();
  38
  39     /**
  40      * Returns the semantic version to import.
  41      *
  42      * @return Semantic version of module to import
  43      */
  44     Optional<SemVer> getSemanticVersion();
  45
  46     /**
  47      * Returns the prefix associated with the imported module.
  48      *
  49      * @return Prefix used to point to imported module
  50      */
  51     String getPrefix();
  52 }