Enrich YinExportUtils

Add ModuleEffectiveStatement-based exporter.

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

diff --git a/yang/yang-model-export/src/main/java/org/opendaylight/yangtools/yang/model/export/YinExportUtils.java b/yang/yang-model-export/src/main/java/org/opendaylight/yangtools/yang/model/export/YinExportUtils.java
index ec536266e7fdf54748ad5f9f04c58481d8c7ac8e..084b161649fc703e66efd77e44371806c3f526c2 100644 (file)
--- a/yang/yang-model-export/src/main/java/org/opendaylight/yangtools/yang/model/export/YinExportUtils.java
+++ b/yang/yang-model-export/src/main/java/org/opendaylight/yangtools/yang/model/export/YinExportUtils.java
@@ -68,14 +68,30 @@ public final class YinExportUtils {
      *                                  representation is not available.
      * @throws NullPointerException if any of of the parameters is null
      * @throws XMLStreamException if an input-output error occurs
+     * @deprecated Prefer {@link #writeModuleAsYinText(ModuleEffectiveStatement, OutputStream)}.
      */
     @Beta
+    @Deprecated
     public static void writeModuleAsYinText(final Module module, final OutputStream output) throws XMLStreamException {
         requireNonNull(module);
         checkArgument(module instanceof ModuleEffectiveStatement, "Module %s is not a ModuleEffectiveStatement",
             module);
-        final ModuleEffectiveStatement effective = (ModuleEffectiveStatement) module;
-        writeReaderToOutput(YinXMLEventReaderFactory.defaultInstance().createXMLEventReader(effective), output);
+        writeModuleAsYinText((ModuleEffectiveStatement) module, output);
+    }
+
+    /**
+     * Write a module as a YIN text into specified {@link OutputStream}. Supplied module must have the
+     * {@link ModuleEffectiveStatement} trait.
+     *
+     * @param module Module to be exported
+     * @throws IllegalArgumentException if the module's declared representation is not available.
+     * @throws NullPointerException if any of of the parameters is null
+     * @throws XMLStreamException if an input-output error occurs
+     */
+    @Beta
+    public static void writeModuleAsYinText(final ModuleEffectiveStatement module, final OutputStream output)
+            throws XMLStreamException {
+        writeReaderToOutput(YinXMLEventReaderFactory.defaultInstance().createXMLEventReader(module), output);
     }
 
     /**
@@ -88,8 +104,11 @@ public final class YinExportUtils {
      *                                  a SubmoduleEffectiveStatement or if its declared representation is not available
      * @throws NullPointerException if any of of the parameters is null
      * @throws XMLStreamException if an input-output error occurs
+     * @deprecated Prefer {@link #writeSubmoduleAsYinText(ModuleEffectiveStatement, SubmoduleEffectiveStatement,
+     *             OutputStream)}.
      */
     @Beta
+    @Deprecated
     public static void writeSubmoduleAsYinText(final Module parentModule, final Module submodule,
             final OutputStream output) throws XMLStreamException {
         requireNonNull(parentModule);
@@ -98,8 +117,25 @@ public final class YinExportUtils {
         requireNonNull(submodule);
         checkArgument(submodule instanceof SubmoduleEffectiveStatement,
             "Submodule %s is not a SubmoduleEffectiveStatement", submodule);
-        writeReaderToOutput(YinXMLEventReaderFactory.defaultInstance().createXMLEventReader(
-            (ModuleEffectiveStatement) parentModule, (SubmoduleEffectiveStatement)submodule), output);
+        writeSubmoduleAsYinText((ModuleEffectiveStatement) parentModule, (SubmoduleEffectiveStatement)submodule,
+            output);
+    }
+
+    /**
+     * Write a submodule as a YIN text into specified {@link OutputStream}. Supplied submodule must have the
+     * {@link SubmoduleEffectiveStatement} trait.
+     *
+     * @param parentModule Parent module
+     * @param submodule Submodule to be exported
+     * @throws IllegalArgumentException if the parent module's or submodule's declared representation is not available
+     * @throws NullPointerException if any of of the parameters is null
+     * @throws XMLStreamException if an input-output error occurs
+     */
+    @Beta
+    public static void writeSubmoduleAsYinText(final ModuleEffectiveStatement parentModule,
+            final SubmoduleEffectiveStatement submodule, final OutputStream output) throws XMLStreamException {
+        writeReaderToOutput(YinXMLEventReaderFactory.defaultInstance().createXMLEventReader(parentModule, submodule),
+            output);
     }
 
     private static void writeReaderToOutput(final XMLEventReader reader, final OutputStream output)