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