model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclarationReference.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.api.meta;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.concepts.Immutable;
  13
  14 /**
  15  * Reference to a statement declaration. This interface serves to provide additional information as to where a
  16  * particular statement comes from. More accurate information may be available through further subclasses of this
  17  * interface such as {@link DeclarationInText} and/or {@link DeclarationInFile}.
  18  */
  19 @Beta
  20 public interface DeclarationReference extends Immutable {
  21     /**
  22      * Returns human readable representation of this reference. This method does not prescribe any format of the
  23      * returned string.
  24      *
  25      * @return human readable representation of this reference.
  26      */
  27     @NonNull String toHumanReadable();
  28 }