Initial opendaylight infrastructure commit!!

[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
new file mode 100644 (file)
index 0000000..5382311
--- /dev/null
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java
@@ -0,0 +1,56 @@
+/*\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