Added support for annotations in generated APIs.

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

diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java
index 538231147aa516b5c1f57ebe1a2af3976c8d4eea..2f70ac5bf5183ef5d9a3347005b571fd98ad7dc4 100644 (file)
--- a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java
@@ -1,56 +1,60 @@
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.controller.sal.binding.model.api;\r
-\r
-import java.util.List;\r
-\r
-/**\r
- * Every Java interface has to be specified with:\r
- * <ul>\r
- * <li><code>package</code> that belongs into</li>\r
- * <li><code>interface</code> name (with commentary that <b>SHOULD</b> be\r
- * present to proper define interface and base <i>contracts</i> specified for\r
- * interface)</li>\r
- * <li><code>enum</code> and <code>constant</code> definitions (i.e. each\r
- * constant definition is by default defined as <code>public static final</code>\r
- * + type (either primitive or object) and constant name</li>\r
- * <li><code>method definitions</code> with specified input parameters (with\r
- * types) and return values</li>\r
- * </ul>\r
- * \r
- * By the definition of the interface constant, enum and method definitions MUST\r
- * be public, so there is no need to specify the scope of visibility.\r
- * \r
- * \r
- */\r
-public interface GeneratedType extends Type {\r
-\r
-    public Type getParentType();\r
-\r
-    /**\r
-     * Returns Set of all Enumerator definitions associated with interface.\r
-     * \r
-     * @return Set of all Enumerator definitions associated with interface.\r
-     */\r
-    public List<Enumeration> getEnumDefintions();\r
-\r
-    /**\r
-     * \r
-     * \r
-     * @return\r
-     */\r
-    public List<Constant> getConstantDefinitions();\r
-\r
-    /**\r
-     * \r
-     * \r
-     * @return\r
-     */\r
-    public List<MethodSignature> getMethodDefinitions();\r
-\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.sal.binding.model.api;
+
+import java.util.List;
+
+/**
+ * Every Java interface has to be specified with:
+ * <ul>
+ * <li><code>package</code> that belongs into</li>
+ * <li><code>interface</code> name (with commentary that <b>SHOULD</b> be
+ * present to proper define interface and base <i>contracts</i> specified for
+ * interface)</li>
+ * <li><code>enum</code> and <code>constant</code> definitions (i.e. each
+ * constant definition is by default defined as <code>public static final</code>
+ * + type (either primitive or object) and constant name</li>
+ * <li><code>method definitions</code> with specified input parameters (with
+ * types) and return values</li>
+ * </ul>
+ * 
+ * By the definition of the interface constant, enum and method definitions MUST
+ * be public, so there is no need to specify the scope of visibility.
+ * 
+ * 
+ */
+public interface GeneratedType extends Type {
+
+    public Type getParentType();
+    
+    public String getComment();
+    
+    public List<AnnotationType> getAnnotations();
+    
+    /**
+     * Returns Set of all Enumerator definitions associated with interface.
+     * 
+     * @return Set of all Enumerator definitions associated with interface.
+     */
+    public List<Enumeration> getEnumDefintions();
+
+    /**
+     * 
+     * 
+     * @return
+     */
+    public List<Constant> getConstantDefinitions();
+
+    /**
+     * 
+     * 
+     * @return
+     */
+    public List<MethodSignature> getMethodDefinitions();
+
+}