Re-organize YANG snippet generation and comment confusion

[mdsal.git] / binding / mdsal-binding-generator-api / src / main / java / org / opendaylight / mdsal / binding / model / api / GeneratedType.java

diff --git a/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/GeneratedType.java b/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/GeneratedType.java
index aedbc37d94418cd206c7b0067b4f304be9b2b143..0f0bd8684effa2c33e57b69d057be13712c32673 100644 (file)
--- a/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/GeneratedType.java
+++ b/binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/GeneratedType.java
@@ -8,6 +8,7 @@
 package org.opendaylight.mdsal.binding.model.api;
 
 import java.util.List;
+import java.util.Optional;
 
 /**
  * Every Java interface has to be specified with:
@@ -49,7 +50,7 @@ public interface GeneratedType extends Type, DocumentedType {
      *
      * @return comment string associated with Generated Type.
      */
-    String getComment();
+    TypeComment getComment();
 
     /**
      * Returns List of annotation definitions associated with generated type.
@@ -113,4 +114,10 @@ public interface GeneratedType extends Type, DocumentedType {
      */
     List<GeneratedProperty> getProperties();
 
+    /**
+     * Returns the YANG definition of this type, if available.
+     *
+     * @return YANG source definition, or empty when unavailable.
+     */
+    Optional<YangSourceDefinition> getYangSourceDefinition();
 }