X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fsal%2Fyang-prototype%2Fcode-generator%2Fbinding-generator-spi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fbinding%2Fgenerator%2Fspi%2FTypeProvider.java;h=93be5a667ca23307002dc7ad73ff1234a94a91a8;hb=ff1b4a79cca00743a00c3b0b1100bd0ab2b2fb31;hp=3c00dee98ea30e95cb4547ffbb1b29cc5f2386f0;hpb=42210c03b0a4c54706320ba9f55794c0abd4d201;p=controller.git

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 3c00dee98e..93be5a667c 100644
--- 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
@@ -15,5 +15,21 @@ public interface TypeProvider {
     @Deprecated
     Type javaTypeForYangType(String type);
 
+    /**
+     * Resolve of yang Type Definition to it's java counter part.
+     * If the Type Definition contains one of yang primitive types the method
+     * will return java.lang. counterpart. (For example if yang type is int32
+     * the java counterpart is java.lang.Integer). In case that Type
+     * Definition contains extended type defined via yang typedef statement
+     * the method SHOULD return Generated Type or Generated Transfer Object
+     * if that Type is correctly referenced to resolved imported yang module.
+     * The method will return <cdoe>null</cdoe> value in situations that
+     * TypeDefinition can't be resolved (either due missing yang import or
+     * incorrectly specified type).
+     *
+     *
+     * @param type Type Definition to resolve from
+     * @return Resolved Type
+     */
     Type javaTypeForSchemaDefinitionType(final TypeDefinition<?> type);
 }