Added Support for Union Type def resolving and bug fixes.

[controller.git] / opendaylight / sal / yang-prototype / code-generator / binding-generator-api / src / main / java / org / opendaylight / controller / sal / binding / generator / api / BindingGenerator.java

diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-api/src/main/java/org/opendaylight/controller/sal/binding/generator/api/BindingGenerator.java b/opendaylight/sal/yang-prototype/code-generator/binding-generator-api/src/main/java/org/opendaylight/controller/sal/binding/generator/api/BindingGenerator.java
index bed7989074c7da7cff666b55d4afbb54f620e910..a9859f76304a6c4953bf7e17adb4619f5164ece8 100644 (file)
--- a/opendaylight/sal/yang-prototype/code-generator/binding-generator-api/src/main/java/org/opendaylight/controller/sal/binding/generator/api/BindingGenerator.java
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-api/src/main/java/org/opendaylight/controller/sal/binding/generator/api/BindingGenerator.java
@@ -7,13 +7,47 @@
  */\r
 package org.opendaylight.controller.sal.binding.generator.api;\r
 \r
-import java.util.List;\r
-\r
 import org.opendaylight.controller.sal.binding.model.api.Type;\r
+import org.opendaylight.controller.yang.model.api.Module;\r
 import org.opendaylight.controller.yang.model.api.SchemaContext;\r
 \r
+import java.util.List;\r
+import java.util.Set;\r
+\r
+/**\r
+ *\r
+ *\r
+ */\r
 public interface BindingGenerator {\r
 \r
+    /**\r
+     * Generate Types from whole Schema Context.\r
+     * <br>\r
+     * The method will return List of All Generated Types that could be\r
+     * Generated from Schema Context.\r
+     *\r
+     *\r
+     * @param context Schema Context\r
+     * @return List of Generated Types\r
+     *\r
+     * @see SchemaContext\r
+     */\r
     public List<Type> generateTypes(final SchemaContext context);\r
 \r
+    /**\r
+     * Generate Types from Schema Context restricted by sub set of specified\r
+     * Modules. The Schema Context MUST contain all of the sub modules\r
+     * otherwise the there is no guarantee that result List of Generated\r
+     * Types will contain correct Generated Types.\r
+     *\r
+     * @param context Schema Context\r
+     * @param modules Sub Set of Modules\r
+     * @return List of Generated Types restricted by sub set of Modules\r
+     *\r
+     * @see Module\r
+     * @see SchemaContext\r
+     *\r
+     */\r
+    public List<Type> generateTypes(final SchemaContext context,\r
+                                    final Set<Module> modules);\r
 }\r