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