2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
10 import java.util.Optional;
11 import org.eclipse.jdt.annotation.NonNull;
12 import org.opendaylight.yangtools.concepts.SemVer;
13 import org.opendaylight.yangtools.yang.common.Revision;
16 * Interface describing YANG 'import' statement. The import statement makes definitions from one module available inside
17 * another module or submodule.
19 // FIXME: 6.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
23 // - Module exposes String->QNameModule mapping
24 public interface ModuleImport extends DocumentedNode {
26 * Returns the name of the module to import.
28 * @return Name of the module to import
30 @NonNull String getModuleName();
33 * Returns the module revision to import. May be null.
35 * @return Revision of module to import
37 Optional<Revision> getRevision();
40 * Returns the semantic version to import.
42 * @return Semantic version of module to import
44 Optional<SemVer> getSemanticVersion();
47 * Returns the prefix associated with the imported module.
49 * @return Prefix used to point to imported module
51 @NonNull String getPrefix();