yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/LeafrefResolver.java

   1 /*
   2  * Copyright (c) 2021 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.model.util;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  13 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  14
  15 /**
  16  * Helper interface aiding resolution of leafref chains.
  17  */
  18 @Beta
  19 @FunctionalInterface
  20 public interface LeafrefResolver {
  21     /**
  22      * Resolve specified {@link LeafrefTypeDefinition} until a non-{@code leafref} type is found.
  23      *
  24      * @param type leafref definition
  25      * @return Resolved type
  26      * @throws NullPointerException if {@code type} is null
  27      * @throws IllegalArgumentException if the type definition cannot be resolved
  28      */
  29     @NonNull TypeDefinition<?> resolveLeafref(@NonNull LeafrefTypeDefinition type);
  30 }