Merge "Ensuring that SET_DL_* action with openflowj only uses OFP_ETH_ALEN bytes...

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

diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/ParameterizedType.java b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/ParameterizedType.java
index 1e800acaa926cc30842e460609042af9edf03c7e..86c4f5af04ccb6bd9e13ba95bddf301aca60a56f 100644 (file)
--- a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/ParameterizedType.java
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/ParameterizedType.java
@@ -9,10 +9,29 @@ package org.opendaylight.controller.sal.binding.model.api;
 \r
 /**\r
  * Represents an instance of simple parametrized type such as List<String>.\r
+ *\r
+ * The parametrized Type is designed to be used to store information of Java\r
+ * Generic Type. The array of {@link #getActualTypeArguments()} holds\r
+ * information of all generic parameters defined for Parameterized Type.\r
  */\r
 public interface ParameterizedType extends Type {\r
 \r
+    /**\r
+     * Returns array of Types that are defined for Parameterized Type.\r
+     * <br>\r
+     * (for example if ParameterizedType encapsulates java generic Map that\r
+     * specifies two parameters Map<K,V> and the K is java.lang.Integer and V\r
+     * is defined as GeneratedType the array will contain two Types to store\r
+     * the information of generic parameters.)\r
+     *\r
+     * @return array of Types that are defined for Parameterized Type.\r
+     */\r
     Type[] getActualTypeArguments();\r
 \r
+    /**\r
+     * Returns the Raw Type definition of Parameterized Type.\r
+     *\r
+     * @return the Raw Type definition of Parameterized Type.\r
+     */\r
     Type getRawType();\r
 }\r