yang/yang-parser-spi/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.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.yang.common.QNameModule;
  15 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  16 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  17
  18 /**
  19  * Source-specific mapping of prefixes to namespaces.
  20  */
  21 public interface PrefixToModule extends IdentifierNamespace<String, QNameModule> {
  22     NamespaceBehaviour<String, QNameModule, @NonNull PrefixToModule> BEHAVIOUR =
  23             NamespaceBehaviour.global(PrefixToModule.class);
  24     String DEFAULT_PREFIX = "";
  25
  26     /**
  27      * Returns QNameModule (namespace + revision) associated with supplied
  28      * prefix.
  29      *
  30      * @param prefix
  31      *            Prefix
  32      * @return QNameModule associated with supplied prefix, or null if prefix is
  33      *         not defined.
  34      */
  35     @Override
  36     @Nullable QNameModule get(@Nonnull String prefix);
  37
  38     /**
  39      * Returns QNameModule (namespace + revision) associated with XML namespace (URI).
  40      *
  41      * @param namespace
  42      *            XML Namespace
  43      * @return QNameModule associated with supplied namespace, or null if prefix
  44      *         is not defined.
  45      * @throws URISyntaxException if the input string is not valid URI
  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     boolean isPreLinkageMap();
  55 }