Deprecate InstanceIdentifierTypeDefinition.getRevisionAwareXPath()

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / type / InstanceIdentifierTypeDefinition.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/InstanceIdentifierTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/InstanceIdentifierTypeDefinition.java
index 3b5f5e0d3fc4e206f147c8c6c7122812a736a635..e5f80de1934332a99df91a4898f768f2b04f138c 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/InstanceIdentifierTypeDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/InstanceIdentifierTypeDefinition.java
@@ -11,27 +11,26 @@ import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 
 /**
- * 
  * Contains methods for getting data from the <code>instance-identifier</code>
  * YANG built-in type.
  */
 public interface InstanceIdentifierTypeDefinition extends TypeDefinition<InstanceIdentifierTypeDefinition> {
 
     /**
-     * Returns XPath for instance of
-     * <code>InstanceIdentifierTypeDefinition</code>.
-     * 
+     * Returns XPath for instance of <code>InstanceIdentifierTypeDefinition</code>.
+     *
      * @return instance of type <code>RevisionAwareXPath</code>
+     * @deprecated This method is deprecated because it is not defined in YANG metamodel. It is scheduled for removal
+     *             in Boron release cycle.
      */
-    public RevisionAwareXPath getPathStatement();
+    @Deprecated
+    RevisionAwareXPath getPathStatement();
 
     /**
-     * Returns true|false which represents argument of
-     * <code>require-instance</code> statement. This statement is the
+     * Returns true|false which represents argument of <code>require-instance</code> statement. This statement is the
      * substatement of the <code>type</code> statement.
-     * 
-     * @return boolean value which is true if the <code>require-instance</code>
-     *         statement is true and vice versa
+     *
+     * @return boolean value which is true if the <code>require-instance</code> statement is true and vice versa
      */
-    public boolean requireInstance();
+    boolean requireInstance();
 }