Add the ability to retain DeclarationReference

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / meta / DeclarationReference.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclarationReference.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclarationReference.java
new file mode 100644 (file)
index 0000000..deca701
--- /dev/null
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/DeclarationReference.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.yang.model.api.meta;
+
+import com.google.common.annotations.Beta;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.concepts.Immutable;
+
+/**
+ * Reference to a statement declaration. This interface serves to provide additional information as to where a
+ * particular statement comes from. More accurate information may be available through further subclasses of this
+ * interface such as {@link DeclarationInText} and/or {@link DeclarationInFile}.
+ */
+@Beta
+public interface DeclarationReference extends Immutable {
+    /**
+     * Returns human readable representation of this reference. This method does not prescribe any format of the
+     * returned string.
+     *
+     * @return human readable representation of this reference.
+     */
+    @NonNull String toHumanReadable();
+}