model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclarationInFile.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.NonNullByDefault;
  12
  13 /**
  14  * A {@link DeclarationReference} to something which resembles file.
  15  */
  16 @Beta
  17 @NonNullByDefault
  18 public interface DeclarationInFile extends DeclarationReference {
  19     /**
  20      * Return the file where the declaration occurred. Returned is guaranteed to be non-empty and reference a file-like
  21      * resource. No further guarantees on structure of the string are made.
  22      *
  23      * @return A non-empty file name.
  24      */
  25     String fileName();
  26 }