Merge "Fix minor bug in FRM proactive flow code path"

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

diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-spi/src/main/java/org/opendaylight/controller/sal/binding/generator/spi/TypeProvider.java b/opendaylight/sal/yang-prototype/code-generator/binding-generator-spi/src/main/java/org/opendaylight/controller/sal/binding/generator/spi/TypeProvider.java
index 3c00dee98ea30e95cb4547ffbb1b29cc5f2386f0..6f74f7a8f2f4b5dc80167c28afd1f708a50b13d5 100644 (file)
--- a/opendaylight/sal/yang-prototype/code-generator/binding-generator-spi/src/main/java/org/opendaylight/controller/sal/binding/generator/spi/TypeProvider.java
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-spi/src/main/java/org/opendaylight/controller/sal/binding/generator/spi/TypeProvider.java
@@ -8,12 +8,28 @@
 package org.opendaylight.controller.sal.binding.generator.spi;\r
 \r
 import org.opendaylight.controller.sal.binding.model.api.Type;\r
-import org.opendaylight.controller.yang.model.api.TypeDefinition;\r
+import org.opendaylight.yangtools.yang.model.api.TypeDefinition;\r
 \r
 public interface TypeProvider {\r
 \r
     @Deprecated\r
     Type javaTypeForYangType(String type);\r
 \r
+    /**\r
+     * Resolve of yang Type Definition to it's java counter part.\r
+     * If the Type Definition contains one of yang primitive types the method\r
+     * will return java.lang. counterpart. (For example if yang type is int32\r
+     * the java counterpart is java.lang.Integer). In case that Type\r
+     * Definition contains extended type defined via yang typedef statement\r
+     * the method SHOULD return Generated Type or Generated Transfer Object\r
+     * if that Type is correctly referenced to resolved imported yang module.\r
+     * The method will return <cdoe>null</cdoe> value in situations that\r
+     * TypeDefinition can't be resolved (either due missing yang import or\r
+     * incorrectly specified type).\r
+     *\r
+     *\r
+     * @param type Type Definition to resolve from\r
+     * @return Resolved Type\r
+     */\r
     Type javaTypeForSchemaDefinitionType(final TypeDefinition<?> type);\r
 }\r