Extended binding-model-api to support of Enclosed Generated Types and TOs.

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

diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedProperty.java b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedProperty.java
index 462e1e1f63c5050b077c7fd13bdd673b2f498be0..119823d7a4054ba39845be4487e2d85b07b5dea3 100644 (file)
--- a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedProperty.java
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedProperty.java
@@ -7,9 +7,24 @@
  */\r
 package org.opendaylight.controller.sal.binding.model.api;\r
 \r
-public interface GeneratedProperty extends MethodSignature {\r
+/**\r
+ * Generated Property extends interface {@link MethodSignature} interface.\r
+ * <br>\r
+ * The Generated Property interface is designed to store information of\r
+ * fields (or members) declared in Java Transfer Objects (or any java\r
+ * classes) and their access counterparts (getters and setters).\r
+ *\r
+ * @see MethodSignature\r
+ */\r
+public interface GeneratedProperty extends TypeMember {\r
 \r
+    /**\r
+     * Returns <code>true</code> if the property si declared as read-only.\r
+     * <br>\r
+     * If the property has flag <code>isReadOnly == true</code> the property\r
+     * SHOULD be generated as getter only.\r
+     *\r
+     * @return <code>true</code> if the property si declared as read-only.\r
+     */\r
     public boolean isReadOnly();\r
-\r
-    public boolean isFinal();\r
 }\r