Introduce top-level pom file.
[mdsal.git] / code-generator / binding-model-api / src / main / java / org / opendaylight / yangtools / sal / binding / model / api / Enumeration.java
index acb4256e4844c8569934036d4ed8e19c5d71649f..9709be32def1212aa5b66ce9024f02891c9e1279 100644 (file)
@@ -1,62 +1,66 @@
-/*\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.yangtools.sal.binding.model.api;\r
-\r
-import java.util.List;\r
-\r
-/**\r
- * Interface provide methods for reading data of enumeration class.\r
- */\r
-public interface Enumeration extends GeneratedType {\r
-\r
-    /**\r
-     * \r
-     * Returns list of annotation definitions associated with enumeration type.\r
-     * \r
-     * @return list of annotation definitions associated with enumeration type.\r
-     * \r
-     */\r
-    public List<AnnotationType> getAnnotations();\r
-\r
-    public Type getParentType();\r
-\r
-    /**\r
-     * Returns list of the couples - name and value.\r
-     * \r
-     * @return list of the enumeration pairs.\r
-     */\r
-    public List<Pair> getValues();\r
-\r
-    /**\r
-     * Formats enumeration according to rules of the programming language.\r
-     * \r
-     * @return string with source code in some programming language\r
-     */\r
-    public String toFormattedString();\r
-\r
-    /**\r
-     * Interface is used for reading enumeration item. It means item's name and\r
-     * its value.\r
-     */\r
-    interface Pair {\r
-\r
-        /**\r
-         * Returns the name of the enumeration item.\r
-         * \r
-         * @return the name of the enumeration item.\r
-         */\r
-        public String getName();\r
-\r
-        /**\r
-         * Returns value of the enumeration item.\r
-         * \r
-         * @return the value of the enumeration item.\r
-         */\r
-        public Integer getValue();\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.yangtools.sal.binding.model.api;
+
+import java.util.List;
+
+import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
+
+/**
+ * Interface provide methods for reading data of enumeration class.
+ */
+public interface Enumeration extends GeneratedType {
+
+    /**
+     *
+     * Returns list of annotation definitions associated with enumeration type.
+     *
+     * @return list of annotation definitions associated with enumeration type.
+     *
+     */
+    @Override
+    List<AnnotationType> getAnnotations();
+
+    @Override
+    Type getParentType();
+
+    /**
+     * Returns list of the couples - name and value.
+     *
+     * @return list of the enumeration pairs.
+     */
+    List<Pair> getValues();
+
+    /**
+     * Formats enumeration according to rules of the programming language.
+     *
+     * @return string with source code in some programming language
+     */
+    String toFormattedString();
+
+    /**
+     * Interface is used for reading enumeration item. It means item's name and
+     * its value.
+     */
+    interface Pair extends DocumentedNode {
+
+        /**
+         * Returns the name of the enumeration item.
+         *
+         * @return the name of the enumeration item.
+         */
+        String getName();
+
+        /**
+         * Returns value of the enumeration item.
+         *
+         * @return the value of the enumeration item.
+         */
+        Integer getValue();
+    }
+}