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  *
  16  * Source-specific mapping of prefixes to namespaces
  17  *
  18  */
  19 public interface PrefixToModule extends IdentifierNamespace<String, QNameModule> {
  20
  21     public static final String DEFAULT_PREFIX = "";
  22
  23
  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      */
  35     @Override
  36     @Nullable QNameModule get(String prefix);
  37
  38     /**
  39      *
  40      * Returns QNameModule (namespace + revision) associated with XML namespace
  41      * (URI).
  42      *
  43      * @param namespace
  44      *            XML Namespace
  45      * @return QNameModule associated with supplied namespace, or null if prefix
  46      *         is not defined.
  47      *
  48      */
  49     @Nullable QNameModule getByNamespace(String namespace);
  50
  51 }