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.Date;
  11 import org.opendaylight.yangtools.concepts.SemVer;
  12
  13 /**
  14  * Interface describing YANG 'import' statement.
  15  * <p>
  16  * The import statement makes definitions from one module available inside
  17  * another module or submodule.
  18  * </p>
  19  */
  20 public interface ModuleImport extends DocumentedNode {
  21
  22     /**
  23      * @return Name of the module to import
  24      */
  25     String getModuleName();
  26
  27     /**
  28      * @return Revision of module to import
  29      */
  30     Date getRevision();
  31
  32     /**
  33      * @return Openconfig version of module to import
  34      */
  35     default SemVer getOpenconfigVersion() {
  36         return Module.DEFAULT_OPENCONFIG_VERSION;
  37     }
  38
  39     /**
  40      * @return Prefix used to point to imported module
  41      */
  42     String getPrefix();
  43 }