Deprecate simple DataTreeFactory.create() 33/113533/1 master
authorRobert Varga <robert.varga@pantheon.tech>
Mon, 16 Sep 2024 09:20:43 +0000 (11:20 +0200)
committerRobert Varga <robert.varga@pantheon.tech>
Mon, 16 Sep 2024 09:27:55 +0000 (11:27 +0200)
We cannot quite guarantee DataTree operation without an
EffectiveModelContext. This patch deprecates the simple method, steering
users towards method which require it.

Change-Id: I2b3f6c6802aed1892113e6d32c131a341a6323ed
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
data/yang-data-tree-api/src/main/java/org/opendaylight/yangtools/yang/data/tree/api/DataTreeFactory.java
data/yang-data-tree-ri/src/main/java/org/opendaylight/yangtools/yang/data/tree/impl/di/InMemoryDataTreeFactory.java
data/yang-data-tree-ri/src/test/java/org/opendaylight/yangtools/yang/data/tree/impl/StructuralApplyModificationTest.java
data/yang-data-tree-ri/src/test/java/org/opendaylight/yangtools/yang/data/tree/impl/UniqueConstraintTest.java

index c8f6644dc94c185ec0bd4e16bb82c294e2102345..dc5117a9397ac85d28bb1c6d1f65537e57e66467 100644 (file)
@@ -29,7 +29,9 @@ public interface DataTreeFactory {
      * @param treeConfig Tree configuration.
      * @return A data tree instance.
      * @throws NullPointerException if treeConfig is null
      * @param treeConfig Tree configuration.
      * @return A data tree instance.
      * @throws NullPointerException if treeConfig is null
+     * @deprecated Use {@link #create(DataTreeConfiguration, EffectiveModelContext)} instead.
      */
      */
+    @Deprecated(since = "14.0.5", forRemoval = true)
     @NonNull DataTree create(DataTreeConfiguration treeConfig);
 
     /**
     @NonNull DataTree create(DataTreeConfiguration treeConfig);
 
     /**
index befd495ee7a009bc48837659859859ce1f65d116..c7c640398b41289df7fc1fb10ad7dbd446e1beca 100644 (file)
@@ -63,6 +63,7 @@ public final class InMemoryDataTreeFactory implements DataTreeFactory {
     }
 
     @Override
     }
 
     @Override
+    @Deprecated
     public DataTree create(final DataTreeConfiguration treeConfig) {
         return new InMemoryDataTree(TreeNode.of(createRoot(treeConfig.getRootPath()),
             Version.initial(treeConfig.isVersionInfoTrackingEnabled())), treeConfig, null);
     public DataTree create(final DataTreeConfiguration treeConfig) {
         return new InMemoryDataTree(TreeNode.of(createRoot(treeConfig.getRootPath()),
             Version.initial(treeConfig.isVersionInfoTrackingEnabled())), treeConfig, null);
index 7be656f7d5045d3d460a11db501d9ec0be802e3c..d54dba0ef32d02b9e6b6478f6c5c11fc5ded8086 100644 (file)
@@ -26,8 +26,8 @@ final class StructuralApplyModificationTest extends AbstractTestModelTest {
 
     @BeforeEach
     void setUp() {
 
     @BeforeEach
     void setUp() {
-        inMemoryDataTree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_CONFIGURATION);
-        inMemoryDataTree.setEffectiveModelContext(SCHEMA_CONTEXT);
+        inMemoryDataTree = new InMemoryDataTreeFactory()
+            .create(DataTreeConfiguration.DEFAULT_CONFIGURATION, SCHEMA_CONTEXT);
     }
 
     @Test
     }
 
     @Test
index 048532b69f6971cb09d93b0ab543859d4bf2cff7..6cbe34528f4b733fc7c8d5352bcf785ca18b5276 100644 (file)
@@ -253,9 +253,9 @@ class UniqueConstraintTest {
 
     private static InMemoryDataTree initDataTree(final EffectiveModelContext schemaContext, final boolean uniqueIndex)
             throws DataValidationFailedException {
 
     private static InMemoryDataTree initDataTree(final EffectiveModelContext schemaContext, final boolean uniqueIndex)
             throws DataValidationFailedException {
-        final var inMemoryDataTree = (InMemoryDataTree) new InMemoryDataTreeFactory().create(
-            new DataTreeConfiguration.Builder(TreeType.CONFIGURATION).setUniqueIndexes(uniqueIndex).build());
-        inMemoryDataTree.setEffectiveModelContext(schemaContext);
+        final var inMemoryDataTree = (InMemoryDataTree) new InMemoryDataTreeFactory()
+            .create(new DataTreeConfiguration.Builder(TreeType.CONFIGURATION).setUniqueIndexes(uniqueIndex).build(),
+                schemaContext);
 
         final var taskNode = ImmutableNodes.newSystemMapBuilder().withNodeIdentifier(new NodeIdentifier(TASK)).build();
         final var modificationTree = inMemoryDataTree.takeSnapshot().newModification();
 
         final var taskNode = ImmutableNodes.newSystemMapBuilder().withNodeIdentifier(new NodeIdentifier(TASK)).build();
         final var modificationTree = inMemoryDataTree.takeSnapshot().newModification();
@@ -271,8 +271,8 @@ class UniqueConstraintTest {
     private static InMemoryDataTree emptyDataTree(final EffectiveModelContext schemaContext,
             final boolean uniqueIndex) {
         final var inMemoryDataTree = (InMemoryDataTree) new InMemoryDataTreeFactory().create(
     private static InMemoryDataTree emptyDataTree(final EffectiveModelContext schemaContext,
             final boolean uniqueIndex) {
         final var inMemoryDataTree = (InMemoryDataTree) new InMemoryDataTreeFactory().create(
-            new DataTreeConfiguration.Builder(TreeType.CONFIGURATION).setUniqueIndexes(uniqueIndex).build());
-        inMemoryDataTree.setEffectiveModelContext(schemaContext);
+            new DataTreeConfiguration.Builder(TreeType.CONFIGURATION).setUniqueIndexes(uniqueIndex).build(),
+            schemaContext);
 
         return inMemoryDataTree;
     }
 
         return inMemoryDataTree;
     }