HONEYCOMB-9: Simplify writer APIs, remove list of DataObjects

Change-Id: I139a883da167f9ab388b41b3ede50e48adc22d0b
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>

1 files changed, 30 insertions, 3 deletions

diff --git a/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/w/ChildVppWriter.java b/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/w/ChildVppWriter.java
index 93c1092b6..243a6528d 100644
--- a/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/w/ChildVppWriter.java
+++ b/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/w/ChildVppWriter.java
@@ -21,19 +21,46 @@ import javax.annotation.Nonnull;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
+/**
+ * Child VPP writer allowing its parent to pass the builder object
+ *
+ * @param <C> Specific DataObject derived type, that is handled by this writer
+ */
 @Beta
 public interface ChildVppWriter<D extends DataObject> extends VppWriter<D> {
 
+    /**
+     * Extract data object managed by this writer from parent data and perform write.
+     *
+     * @param parentId Id of parent node
+     * @param parentDataAfter Parent data from modification to extract data object from
+     * @param ctx Write context for current modification
+     */
     void writeChild(@Nonnull final InstanceIdentifier<? extends DataObject> parentId,
                     @Nonnull final DataObject parentDataAfter,
-                    @Nonnull WriteContext ctx);
+                    @Nonnull final WriteContext ctx);
 
+    /**
+     * Extract data object managed by this writer(if necessary) from parent data and perform delete.
+     *
+     * @param parentId Id of parent node
+     * @param parentDataBefore Parent data before modification to extract data object from
+     * @param ctx Write context for current modification
+     */
     void deleteChild(@Nonnull final InstanceIdentifier<? extends DataObject> parentId,
                      @Nonnull final DataObject parentDataBefore,
-                     @Nonnull WriteContext ctx);
+                     @Nonnull final WriteContext ctx);
 
+    /**
+     * Extract data object managed by this writer(if necessary) from parent data and perform delete.
+     *
+     * @param parentId Id of parent node
+     * @param parentDataBefore Parent data before modification to extract data object from
+     * @param parentDataAfter Parent data from modification to extract data object from
+     * @param ctx Write context for current modification
+     */
     void updateChild(@Nonnull final InstanceIdentifier<? extends DataObject> parentId,
                      @Nonnull final DataObject parentDataBefore,
                      @Nonnull final DataObject parentDataAfter,
-                     @Nonnull WriteContext ctx);
+                     @Nonnull final WriteContext ctx);
 }