Deprecate EffectiveModelContextProvider.getSchemaContext()

Steer users towards using EffectiveModelContext -- if they already
have an EffectiveModelContextProvider, they should not be using
getSchemaContext().

Change-Id: Ibcbfa9926a66a3890c1ae3b163c5a16841c2a716
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContextProvider.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContextProvider.java
index fa6421ac864373e9a202ff4d56a73f62e7537224..18b3b42ce96db2f7b9ecf283656c2c66fbcc05f2 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContextProvider.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveModelContextProvider.java
@@ -25,6 +25,12 @@ public interface EffectiveModelContextProvider extends SchemaContextProvider {
      */
     @NonNull EffectiveModelContext getEffectiveModelContext();
 
+    /**
+     * {@inheritDoc}
+     *
+     * @deprecated Please use {@link #getEffectiveModelContext()} instead.
+     */
+    @Deprecated
     @Override
     default SchemaContext getSchemaContext() {
         return getEffectiveModelContext();

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContextProvider.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContextProvider.java
index 3ee9badb9fdcd5512aaca2da7636a5d1e8e71162..5f93f0fe921c69f75cbd5dfd4a878bd5edaae247 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContextProvider.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContextProvider.java
@@ -9,7 +9,7 @@ package org.opendaylight.yangtools.yang.model.api;
 
 import org.eclipse.jdt.annotation.NonNull;
 
-// FIXME: document this API contract
+// FIXME: 6.0.0: remove this contract
 public interface SchemaContextProvider {
     /**
      * Return the {@link SchemaContext} attached to this object.