Add ReusableImmutableNormalizedNodeStreamWriter

In certain situations it can be beneficial to reuse the same
writer multiple times, resetting it between uses.

This patch adds a reusable version of
ImmutableNormalizedNodeStreamWriter, which provides this service.

JIRA: YANGTOOLS-988
Change-Id: Id74e8ddcaec0e730e805cf300d455c6bf5357156
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java
index 09a6840be218b750f3bf80630fd09ba73a3a2965..2b2e5857fbdc30205a86493a2254a820ab1bfacd 100644 (file)
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java
@@ -302,6 +302,12 @@ public class ImmutableNormalizedNodeStreamWriter implements NormalizedNodeStream
         return builders.pop();
     }
 
+    final void reset(final NormalizedNodeResultBuilder builder) {
+        nextSchema = null;
+        builders.clear();
+        builders.push(builder);
+    }
+
     private void checkDataNodeContainer() {
         @SuppressWarnings("rawtypes")
         final NormalizedNodeContainerBuilder current = currentContainer();

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeMetadataResult.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeMetadataResult.java
index 160db0b4d034adbcbf53eab82de14845ee89c06f..84424ed54d7f46669552ecd843ce4b0f9c24bde1 100644 (file)
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeMetadataResult.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeMetadataResult.java
@@ -28,4 +28,10 @@ public class NormalizedNodeMetadataResult extends NormalizedNodeResult {
     void setResult(final NormalizedMetadata metadata) {
         this.metadata = metadata;
     }
+
+    @Override
+    void reset() {
+        metadata = null;
+        super.reset();
+    }
 }

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResult.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResult.java
index 85d41a78a16c5cada404315015a36daba7ad1b0e..6751515059ed73da06f6acc78b7e61b941831ab5 100644 (file)
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResult.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResult.java
@@ -30,6 +30,10 @@ public class NormalizedNodeResult {
         return result;
     }
 
+    public boolean isFinished() {
+        return finished;
+    }
+
     void setResult(final NormalizedNode<?, ?> result) {
         if (finished) {
             throw new ResultAlreadySetException("Normalized Node result was already set.", this.result);
@@ -38,7 +42,8 @@ public class NormalizedNodeResult {
         this.result = result;
     }
 
-    public boolean isFinished() {
-        return finished;
+    void reset() {
+        result = null;
+        finished = false;
     }
 }

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResultBuilder.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResultBuilder.java
index 13d45bbb2bce884ff0c6965f36e667a4c09b28f3..c4617db968e2941cfb6a67c3201e6c73ed996e2d 100644 (file)
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResultBuilder.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/NormalizedNodeResultBuilder.java
@@ -7,7 +7,10 @@
  */
 package org.opendaylight.yangtools.yang.data.impl.schema;
 
+import static java.util.Objects.requireNonNull;
+
 import java.util.Collection;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
@@ -15,10 +18,18 @@ import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNo
 
 @SuppressWarnings("rawtypes")
 final class NormalizedNodeResultBuilder implements NormalizedNodeContainerBuilder {
-    private final NormalizedNodeResult result;
+    private final @NonNull NormalizedNodeResult result;
+
+    NormalizedNodeResultBuilder() {
+        this.result = new NormalizedNodeResult();
+    }
 
     NormalizedNodeResultBuilder(final NormalizedNodeResult result) {
-        this.result = result;
+        this.result = requireNonNull(result);
+    }
+
+    @NonNull NormalizedNodeResult result() {
+        return result;
     }
 
     @Override

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ReusableImmutableNormalizedNodeStreamWriter.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ReusableImmutableNormalizedNodeStreamWriter.java
new file mode 100644 (file)
index 0000000..c9f7974
--- /dev/null
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ReusableImmutableNormalizedNodeStreamWriter.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2019 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.data.impl.schema;
+
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.Beta;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+
+/**
+ * A reusable variant of {@link ImmutableNormalizedNodeStreamWriter}. It can be reset into its base state and used for
+ * multiple streaming sessions.
+ */
+@Beta
+public final class ReusableImmutableNormalizedNodeStreamWriter extends ImmutableNormalizedNodeStreamWriter {
+    private final NormalizedNodeResultBuilder builder;
+
+    private ReusableImmutableNormalizedNodeStreamWriter(final NormalizedNodeResultBuilder builder) {
+        super(builder);
+        this.builder = requireNonNull(builder);
+    }
+
+    public static @NonNull ReusableImmutableNormalizedNodeStreamWriter create() {
+        return new ReusableImmutableNormalizedNodeStreamWriter(new NormalizedNodeResultBuilder());
+    }
+
+    public void reset() {
+        builder.result().reset();
+        reset(builder);
+    }
+
+    public NormalizedNode<?, ?> getResult() {
+        return builder.result().getResult();
+    }
+}