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