parser/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/source/PrefixResolver.java

   1 /*
   2  * Copyright (c) 2022 PANTHEON.tech, s.r.o. 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.common.Revision;
  14
  15 /**
  16  * Interface for resolving XML prefixes to their bound {@link QNameModule}s. This resolution entails determining
  17  * the correct {@link Revision} bound at the use site.
  18  */
  19 public interface PrefixResolver {
  20     /**
  21      * Returns QNameModule (namespace + revision) associated with supplied prefix.
  22      *
  23      * @param prefix Prefix
  24      * @return QNameModule associated with supplied prefix, or null if prefix is not defined.
  25      */
  26     @Nullable QNameModule resolvePrefix(@NonNull String prefix);
  27 }