yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/PrefixToModule.java

   1 /*
   2  * Copyright (c) 2015 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.parser.spi.source;
   9
  10 import java.net.URISyntaxException;
  11 import javax.annotation.Nullable;
  12 import org.opendaylight.yangtools.yang.common.QNameModule;
  13 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  14
  15 /**
  16  * Source-specific mapping of prefixes to namespaces
  17  */
  18 public interface PrefixToModule extends IdentifierNamespace<String, QNameModule> {
  19
  20     String DEFAULT_PREFIX = "";
  21
  22     /**
  23      * Returns QNameModule (namespace + revision) associated with supplied
  24      * prefix.
  25      *
  26      * @param prefix
  27      *            Prefix
  28      * @return QNameModule associated with supplied prefix, or null if prefix is
  29      *         not defined.
  30      *
  31      */
  32     @Override
  33     @Nullable QNameModule get(String prefix);
  34
  35     /**
  36      * Returns QNameModule (namespace + revision) associated with XML namespace
  37      * (URI).
  38      *
  39      * @param namespace
  40      *            XML Namespace
  41      * @return QNameModule associated with supplied namespace, or null if prefix
  42      *         is not defined.
  43      * @throws URISyntaxException if the input string is not valid URI
  44      *
  45      */
  46     @Nullable QNameModule getByNamespace(String namespace) throws URISyntaxException;
  47
  48     /**
  49      * Pre-linkage map does not consider revision-dates of modules and it contains module namespaces only.
  50      *
  51      * @return true if it is the pre-linkage map.
  52      *
  53      */
  54     boolean isPreLinkageMap();
  55 }