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