VPP composite reader APIs

Base APIs for composite and extensible VPP readers

Change-Id: Ic3d7c697fbffe40ab0d0ce3fea0a21cf89c652d0
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>

1 files changed, 41 insertions, 0 deletions

diff --git a/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/ChildVppReader.java b/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/ChildVppReader.java
new file mode 100644
index 000000000..5d57c6064
--- /dev/null
+++ b/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/ChildVppReader.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fd.honeycomb.v3po.impl.trans;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Child VPP reader allowing its parent to pass the builder object
+ */
+@Beta
+public interface ChildVppReader<C extends DataObject> extends VppReader<C> {
+
+    /**
+     * Read subtree starting from node managed by this reader and place the subtree within parent builder object if
+     * the data exists.
+     *
+     * @param id Unique identifier pointing to the node managed by this reader. Useful when necessary to determine
+     *           the exact position within more complex subtrees.
+     */
+    void read(@Nonnull final InstanceIdentifier<? extends DataObject> id,
+              @Nonnull final Builder<? extends DataObject> parentBuilder);
+
+}
+