Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yangutils.translator.tojava.utils; |
| 18 | |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 19 | import java.util.List; |
| 20 | |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.datamodel.YangCompilerAnnotation; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.datamodel.YangNode; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 23 | import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 24 | import org.onosproject.yangutils.translator.tojava.JavaQualifiedTypeInfoTranslator; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 25 | import org.onosproject.yangutils.translator.tojava.TempJavaServiceFragmentFiles; |
Gaurav Agrawal | 8a14752 | 2016-08-10 13:43:01 +0530 | [diff] [blame] | 26 | import org.onosproject.yangutils.utils.io.YangPluginConfig; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 27 | |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 28 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getEnumJavaAttribute; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 29 | import static org.onosproject.yangutils.utils.UtilConstants.ARRAY_LIST; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 30 | import static org.onosproject.yangutils.utils.UtilConstants.CLASS_STRING; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 31 | import static org.onosproject.yangutils.utils.UtilConstants.CLOSE_CURLY_BRACKET; |
Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 32 | import static org.onosproject.yangutils.utils.UtilConstants.CLOSE_PARENTHESIS; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.utils.UtilConstants.COMMA; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 34 | import static org.onosproject.yangutils.utils.UtilConstants.DIAMOND_CLOSE_BRACKET; |
| 35 | import static org.onosproject.yangutils.utils.UtilConstants.DIAMOND_OPEN_BRACKET; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 36 | import static org.onosproject.yangutils.utils.UtilConstants.EIGHT_SPACE_INDENTATION; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.utils.UtilConstants.ENUM; |
Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.utils.UtilConstants.EQUAL; |
| 39 | import static org.onosproject.yangutils.utils.UtilConstants.FOUR_SPACE_INDENTATION; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 40 | import static org.onosproject.yangutils.utils.UtilConstants.HASH_MAP; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 41 | import static org.onosproject.yangutils.utils.UtilConstants.IMPORT; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 42 | import static org.onosproject.yangutils.utils.UtilConstants.INT; |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 43 | import static org.onosproject.yangutils.utils.UtilConstants.INT_MAX_RANGE_ATTR; |
| 44 | import static org.onosproject.yangutils.utils.UtilConstants.INT_MIN_RANGE_ATTR; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 45 | import static org.onosproject.yangutils.utils.UtilConstants.LIST; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 46 | import static org.onosproject.yangutils.utils.UtilConstants.LISTENER_SERVICE; |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 47 | import static org.onosproject.yangutils.utils.UtilConstants.LONG_MAX_RANGE_ATTR; |
| 48 | import static org.onosproject.yangutils.utils.UtilConstants.LONG_MIN_RANGE_ATTR; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 49 | import static org.onosproject.yangutils.utils.UtilConstants.MAP; |
| 50 | import static org.onosproject.yangutils.utils.UtilConstants.NEW; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 51 | import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 52 | import static org.onosproject.yangutils.utils.UtilConstants.OBJECT_STRING; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 53 | import static org.onosproject.yangutils.utils.UtilConstants.OPEN_CURLY_BRACKET; |
Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 54 | import static org.onosproject.yangutils.utils.UtilConstants.OPEN_PARENTHESIS; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 55 | import static org.onosproject.yangutils.utils.UtilConstants.PERIOD; |
| 56 | import static org.onosproject.yangutils.utils.UtilConstants.PRIVATE; |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 57 | import static org.onosproject.yangutils.utils.UtilConstants.PROTECTED; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 58 | import static org.onosproject.yangutils.utils.UtilConstants.PUBLIC; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 59 | import static org.onosproject.yangutils.utils.UtilConstants.QUESTION_MARK; |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 60 | import static org.onosproject.yangutils.utils.UtilConstants.QUEUE; |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame^] | 61 | import static org.onosproject.yangutils.utils.UtilConstants.QUOTES; |
| 62 | import static org.onosproject.yangutils.utils.UtilConstants.SCHEMA_NAME; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 63 | import static org.onosproject.yangutils.utils.UtilConstants.SEMI_COLAN; |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 64 | import static org.onosproject.yangutils.utils.UtilConstants.SET; |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 65 | import static org.onosproject.yangutils.utils.UtilConstants.SHORT_MAX_RANGE_ATTR; |
| 66 | import static org.onosproject.yangutils.utils.UtilConstants.SHORT_MIN_RANGE_ATTR; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 67 | import static org.onosproject.yangutils.utils.UtilConstants.SPACE; |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame^] | 68 | import static org.onosproject.yangutils.utils.UtilConstants.STRING_DATA_TYPE; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 69 | import static org.onosproject.yangutils.utils.UtilConstants.TYPE; |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 70 | import static org.onosproject.yangutils.utils.UtilConstants.UINT8_MAX_RANGE_ATTR; |
| 71 | import static org.onosproject.yangutils.utils.UtilConstants.UINT8_MIN_RANGE_ATTR; |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 72 | import static org.onosproject.yangutils.utils.UtilConstants.UINT_MAX_RANGE_ATTR; |
| 73 | import static org.onosproject.yangutils.utils.UtilConstants.UINT_MIN_RANGE_ATTR; |
| 74 | import static org.onosproject.yangutils.utils.UtilConstants.ULONG_MAX_RANGE_ATTR; |
| 75 | import static org.onosproject.yangutils.utils.UtilConstants.ULONG_MIN_RANGE_ATTR; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 76 | import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUGMENTED_INFO; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 77 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.ENUM_ATTRIBUTE; |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame^] | 78 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.enumJavaDocForInnerClass; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 79 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc; |
| 80 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getSmallCase; |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 81 | |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 82 | import static java.util.Collections.sort; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 83 | |
| 84 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 85 | * Represents utility class to generate the java snippet. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 86 | */ |
| 87 | public final class JavaCodeSnippetGen { |
| 88 | |
| 89 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 90 | * Creates an instance of java code snippet gen. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 91 | */ |
| 92 | private JavaCodeSnippetGen() { |
| 93 | } |
| 94 | |
| 95 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 96 | * Returns the java file header comment. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 97 | * |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 98 | * @return the java file header comment |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 99 | */ |
| 100 | public static String getFileHeaderComment() { |
| 101 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 102 | /* |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 103 | * TODO return the file header. |
| 104 | */ |
| 105 | return null; |
| 106 | } |
| 107 | |
| 108 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 109 | * Returns the textual java code information corresponding to the import list. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 110 | * |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 111 | * @param importInfo import info |
Bharat saraswal | 039f59c | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 112 | * @return the textual java code information corresponding to the import list |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 113 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 114 | static String getImportText(JavaQualifiedTypeInfoTranslator importInfo) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 115 | return IMPORT + importInfo.getPkgInfo() + PERIOD + importInfo.getClassInfo() + SEMI_COLAN + NEW_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 116 | } |
| 117 | |
| 118 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 119 | * Returns the textual java code for attribute definition in class. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 120 | * |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 121 | * @param javaAttributeTypePkg Package of the attribute type |
| 122 | * @param javaAttributeType java attribute type |
| 123 | * @param javaAttributeName name of the attribute |
| 124 | * @param isList is list attribute |
| 125 | * @param attributeAccessType attribute access type |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 126 | * @param compilerAnnotation compiler annotation |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 127 | * @return the textual java code for attribute definition in class |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 128 | */ |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 129 | public static String getJavaAttributeDefinition(String javaAttributeTypePkg, String javaAttributeType, |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 130 | String javaAttributeName, boolean isList, |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 131 | String attributeAccessType, |
| 132 | YangCompilerAnnotation compilerAnnotation) { |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 133 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 134 | String attributeDefinition = attributeAccessType + SPACE; |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 135 | |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 136 | if (!isList) { |
| 137 | if (javaAttributeTypePkg != null) { |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 138 | attributeDefinition = attributeDefinition + javaAttributeTypePkg + PERIOD; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 139 | } |
| 140 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 141 | attributeDefinition = attributeDefinition + javaAttributeType + SPACE + javaAttributeName + SEMI_COLAN |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 142 | + NEW_LINE; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 143 | } else { |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 144 | if (compilerAnnotation != null && compilerAnnotation.getYangAppDataStructure() != null) { |
| 145 | switch (compilerAnnotation.getYangAppDataStructure().getDataStructure()) { |
| 146 | case QUEUE: { |
| 147 | attributeDefinition = attributeDefinition + QUEUE + DIAMOND_OPEN_BRACKET; |
| 148 | break; |
| 149 | } |
| 150 | case SET: { |
| 151 | attributeDefinition = attributeDefinition + SET + DIAMOND_OPEN_BRACKET; |
| 152 | break; |
| 153 | } |
| 154 | default: { |
| 155 | attributeDefinition = attributeDefinition + LIST + DIAMOND_OPEN_BRACKET; |
| 156 | } |
| 157 | } |
| 158 | } else { |
| 159 | attributeDefinition = attributeDefinition + LIST + DIAMOND_OPEN_BRACKET; |
| 160 | } |
| 161 | |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 162 | if (javaAttributeTypePkg != null) { |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 163 | attributeDefinition = attributeDefinition + javaAttributeTypePkg + PERIOD; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 164 | } |
| 165 | |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 166 | attributeDefinition = attributeDefinition + javaAttributeType; |
| 167 | |
| 168 | if (compilerAnnotation != null && compilerAnnotation.getYangAppDataStructure() != null) { |
| 169 | switch (compilerAnnotation.getYangAppDataStructure().getDataStructure()) { |
| 170 | default: { |
| 171 | attributeDefinition = attributeDefinition + DIAMOND_CLOSE_BRACKET + SPACE |
| 172 | + javaAttributeName + SEMI_COLAN + NEW_LINE; |
| 173 | } |
| 174 | } |
| 175 | } else { |
| 176 | attributeDefinition = attributeDefinition + DIAMOND_CLOSE_BRACKET + SPACE |
| 177 | + javaAttributeName + SPACE + EQUAL + SPACE + NEW + SPACE |
| 178 | + ARRAY_LIST + SEMI_COLAN + NEW_LINE; |
| 179 | } |
| 180 | |
Bharat saraswal | 5e3c45c | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 181 | } |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 182 | return attributeDefinition; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | /** |
Bharat saraswal | 039f59c | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 186 | * Returns based on the file type and the YANG name of the file, generate the class / interface definition close. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 187 | * |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 188 | * @return corresponding textual java code information |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 189 | */ |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 190 | public static String getJavaClassDefClose() { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 191 | return CLOSE_CURLY_BRACKET; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 192 | } |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 193 | |
| 194 | /** |
| 195 | * Returns string for enum's attribute. |
| 196 | * |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame^] | 197 | * @param name name of attribute |
| 198 | * @param value value of the enum |
| 199 | * @return string for enum's attribute |
| 200 | */ |
| 201 | public static String generateEnumAttributeString(String name, int value) { |
| 202 | String enumName = getEnumJavaAttribute(name); |
| 203 | return NEW_LINE + enumJavaDocForInnerClass(name) |
| 204 | + EIGHT_SPACE_INDENTATION + enumName.toUpperCase() + OPEN_PARENTHESIS |
| 205 | + value + CLOSE_PARENTHESIS + COMMA + NEW_LINE; |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Returns string for enum's attribute for enum class. |
| 210 | * |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 211 | * @param name name of attribute |
| 212 | * @param value value of the enum |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 213 | * @param pluginConfig plugin configurations |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 214 | * @return string for enum's attribute |
| 215 | */ |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame^] | 216 | public static String generateEnumAttributeStringWithSchemaName(String name, int value, YangPluginConfig |
| 217 | pluginConfig) { |
| 218 | String enumName = getEnumJavaAttribute(name); |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 219 | return NEW_LINE + getJavaDoc(ENUM_ATTRIBUTE, name, false, pluginConfig, null) |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame^] | 220 | + FOUR_SPACE_INDENTATION + enumName.toUpperCase() + OPEN_PARENTHESIS |
| 221 | + value + COMMA + SPACE + QUOTES + name + QUOTES + CLOSE_PARENTHESIS + COMMA + NEW_LINE; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 222 | } |
| 223 | |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 224 | /** |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 225 | * Returns sorted import list. |
| 226 | * |
| 227 | * @param imports import list |
| 228 | * @return sorted import list |
| 229 | */ |
| 230 | public static List<String> sortImports(List<String> imports) { |
| 231 | sort(imports); |
| 232 | return imports; |
| 233 | } |
| 234 | |
| 235 | /** |
| 236 | * Returns event enum start. |
| 237 | * |
| 238 | * @return event enum start |
| 239 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 240 | static String getEventEnumTypeStart() { |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 241 | return FOUR_SPACE_INDENTATION + PUBLIC + SPACE + ENUM + SPACE + TYPE + SPACE + OPEN_CURLY_BRACKET |
| 242 | + NEW_LINE; |
| 243 | } |
| 244 | |
| 245 | /** |
| 246 | * Adds listener's imports. |
| 247 | * |
| 248 | * @param curNode currentYangNode. |
| 249 | * @param imports import list |
| 250 | * @param operation add or remove |
| 251 | * @param classInfo class info to be added to import list |
| 252 | */ |
| 253 | public static void addListenersImport(YangNode curNode, List<String> imports, boolean operation, |
| 254 | String classInfo) { |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 255 | String thisImport; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 256 | TempJavaServiceFragmentFiles tempJavaServiceFragmentFiles = ((JavaCodeGeneratorInfo) curNode) |
| 257 | .getTempJavaCodeFragmentFiles().getServiceTempFiles(); |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 258 | if (classInfo.equals(LISTENER_SERVICE)) { |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 259 | thisImport = tempJavaServiceFragmentFiles.getJavaImportData().getListenerServiceImport(); |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 260 | performOperationOnImports(imports, thisImport, operation); |
| 261 | } else { |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 262 | thisImport = tempJavaServiceFragmentFiles.getJavaImportData().getListenerRegistryImport(); |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 263 | performOperationOnImports(imports, thisImport, operation); |
| 264 | } |
| 265 | } |
| 266 | |
| 267 | /** |
| 268 | * Performs given operations on import list. |
| 269 | * |
| 270 | * @param imports list of imports |
| 271 | * @param curImport current import |
| 272 | * @param operation add or remove |
| 273 | * @return import list |
| 274 | */ |
| 275 | private static List<String> performOperationOnImports(List<String> imports, String curImport, |
| 276 | boolean operation) { |
| 277 | if (operation) { |
| 278 | imports.add(curImport); |
| 279 | } else { |
| 280 | imports.remove(curImport); |
| 281 | } |
| 282 | sortImports(imports); |
| 283 | return imports; |
| 284 | } |
| 285 | |
| 286 | /** |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 287 | * Returns integer attribute for enum's class to get the values. |
| 288 | * |
| 289 | * @param className enum's class name |
| 290 | * @return enum's attribute |
| 291 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 292 | static String getEnumsValueAttribute(String className) { |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 293 | return NEW_LINE + FOUR_SPACE_INDENTATION + PRIVATE + SPACE + INT + SPACE + getSmallCase(className) |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame^] | 294 | + SEMI_COLAN + NEW_LINE + FOUR_SPACE_INDENTATION + PRIVATE + SPACE + STRING_DATA_TYPE + SPACE + |
| 295 | SCHEMA_NAME + SEMI_COLAN + NEW_LINE; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 296 | } |
| 297 | |
| 298 | /** |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 299 | * Returns attribute for augmentation. |
| 300 | * |
| 301 | * @return attribute for augmentation |
| 302 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 303 | static String addAugmentationAttribute() { |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 304 | return NEW_LINE + FOUR_SPACE_INDENTATION + PROTECTED + SPACE + MAP + DIAMOND_OPEN_BRACKET + CLASS_STRING |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 305 | + DIAMOND_OPEN_BRACKET + QUESTION_MARK + DIAMOND_CLOSE_BRACKET + COMMA + SPACE + OBJECT_STRING |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 306 | + DIAMOND_CLOSE_BRACKET + SPACE + getSmallCase(YANG_AUGMENTED_INFO) + MAP + SPACE + EQUAL + SPACE + |
| 307 | NEW + SPACE + HASH_MAP + DIAMOND_OPEN_BRACKET + DIAMOND_CLOSE_BRACKET + OPEN_PARENTHESIS |
| 308 | + CLOSE_PARENTHESIS + SEMI_COLAN; |
| 309 | } |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 310 | |
| 311 | /** |
| 312 | * Adds attribute for int ranges. |
| 313 | * |
| 314 | * @param modifier modifier for attribute |
| 315 | * @param addFirst true if int need to be added fist. |
| 316 | * @return attribute for int ranges |
| 317 | */ |
| 318 | static String addStaticAttributeIntRange(String modifier, boolean addFirst) { |
| 319 | if (addFirst) { |
| 320 | return NEW_LINE + FOUR_SPACE_INDENTATION + modifier + SPACE + INT_MIN_RANGE_ATTR + FOUR_SPACE_INDENTATION + |
| 321 | modifier + |
| 322 | SPACE + INT_MAX_RANGE_ATTR; |
| 323 | } else { |
| 324 | return NEW_LINE + FOUR_SPACE_INDENTATION + modifier + SPACE + UINT_MIN_RANGE_ATTR + FOUR_SPACE_INDENTATION + |
| 325 | modifier + SPACE + UINT_MAX_RANGE_ATTR; |
| 326 | } |
| 327 | } |
| 328 | |
| 329 | /** |
| 330 | * Adds attribute for long ranges. |
| 331 | * |
| 332 | * @param modifier modifier for attribute |
| 333 | * @param addFirst if need to be added first |
| 334 | * @return attribute for long ranges |
| 335 | */ |
| 336 | static String addStaticAttributeLongRange(String modifier, boolean addFirst) { |
| 337 | if (addFirst) { |
| 338 | return NEW_LINE + FOUR_SPACE_INDENTATION + modifier + SPACE + LONG_MIN_RANGE_ATTR + FOUR_SPACE_INDENTATION + |
| 339 | modifier + SPACE + LONG_MAX_RANGE_ATTR; |
| 340 | } else { |
| 341 | return NEW_LINE + FOUR_SPACE_INDENTATION + modifier + SPACE + ULONG_MIN_RANGE_ATTR + |
| 342 | FOUR_SPACE_INDENTATION + modifier + SPACE + ULONG_MAX_RANGE_ATTR; |
| 343 | } |
| 344 | } |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 345 | |
| 346 | /** |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 347 | * Adds attribute for long ranges. |
| 348 | * |
| 349 | * @param modifier modifier for attribute |
| 350 | * @param addFirst if need to be added first |
| 351 | * @return attribute for long ranges |
| 352 | */ |
| 353 | static String addStaticAttributeShortRange(String modifier, boolean addFirst) { |
| 354 | if (addFirst) { |
| 355 | return NEW_LINE + FOUR_SPACE_INDENTATION + modifier + SPACE + SHORT_MIN_RANGE_ATTR + |
| 356 | FOUR_SPACE_INDENTATION + |
| 357 | modifier + SPACE + SHORT_MAX_RANGE_ATTR; |
| 358 | } else { |
| 359 | return NEW_LINE + FOUR_SPACE_INDENTATION + modifier + SPACE + UINT8_MIN_RANGE_ATTR + |
| 360 | FOUR_SPACE_INDENTATION + modifier + SPACE + UINT8_MAX_RANGE_ATTR; |
| 361 | } |
| 362 | } |
| 363 | |
| 364 | /** |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 365 | * Returns operation type enum. |
| 366 | * |
| 367 | * @return operation type enum |
| 368 | */ |
| 369 | static String getOperationTypeEnum() { |
| 370 | return "\n" + |
| 371 | " /**\n" + |
| 372 | " * Specify the node specific operation in protocols like NETCONF.\n" + |
| 373 | " * Applicable in protocol edit operation, not applicable in query operation\n" + |
| 374 | " */\n" + |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 375 | " public enum OnosYangNodeOperationType {\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 376 | " MERGE,\n" + |
| 377 | " REPLACE,\n" + |
| 378 | " CREATE,\n" + |
| 379 | " DELETE,\n" + |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 380 | " REMOVE,\n" + |
| 381 | " NONE\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 382 | " }\n"; |
| 383 | } |
| 384 | |
| 385 | /** |
| 386 | * Returns operation type enum, leaf value set attribute and select leaf attribute. |
| 387 | * |
| 388 | * @return operation type enum, leaf value set attribute and select leaf attribute. |
| 389 | */ |
| 390 | static String getOperationAttributes() { |
| 391 | return " /**\n" + |
| 392 | " * Identify the leafs whose value are explicitly set\n" + |
| 393 | " * Applicable in protocol edit and query operation\n" + |
| 394 | " */\n" + |
Gaurav Agrawal | 8a14752 | 2016-08-10 13:43:01 +0530 | [diff] [blame] | 395 | " private BitSet valueLeafFlags = new BitSet();\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 396 | "\n" + |
| 397 | " /**\n" + |
| 398 | " * Identify the leafs to be selected, in a query operation\n" + |
| 399 | " */\n" + |
Gaurav Agrawal | 8a14752 | 2016-08-10 13:43:01 +0530 | [diff] [blame] | 400 | " private BitSet selectLeafFlags = new BitSet();\n"; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 401 | } |
| 402 | |
| 403 | /** |
| 404 | * Returns operation type enum, leaf value set attribute and select leaf attribute. |
| 405 | * |
| 406 | * @return operation type enum, leaf value set attribute and select leaf attribute. |
| 407 | */ |
| 408 | static String getOperationTypeAttr() { |
| 409 | return "\n /**\n" + |
| 410 | " * Specify the node specific operation in protocols like NETCONF.\n" + |
| 411 | " * Applicable in protocol edit operation, will be ignored in query operation\n" + |
| 412 | " */\n" + |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 413 | " private OnosYangNodeOperationType onosYangNodeOperationType;\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 414 | "\n"; |
| 415 | } |
| 416 | |
| 417 | /** |
| 418 | * Returns operation type enum, leaf value set attribute and select leaf attribute for constructor. |
| 419 | * |
| 420 | * @return operation type enum, leaf value set attribute and select leaf attribute for constructor |
| 421 | */ |
| 422 | static String getOperationAttributeForConstructor() { |
Gaurav Agrawal | 8a14752 | 2016-08-10 13:43:01 +0530 | [diff] [blame] | 423 | return " this.valueLeafFlags = builderObject.getValueLeafFlags();\n" + |
| 424 | " this.selectLeafFlags = builderObject.getSelectLeafFlags();\n"; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 425 | } |
| 426 | |
| 427 | /** |
| 428 | * Returns operation type enum, leaf value set attribute and select leaf attribute for constructor. |
| 429 | * |
| 430 | * @return operation type enum, leaf value set attribute and select leaf attribute for constructor |
| 431 | */ |
| 432 | static String getOperationTypeForConstructor() { |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 433 | return " this.onosYangNodeOperationType = builderObject.onosYangNodeOperationType();\n"; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 434 | } |
| 435 | |
Bharat saraswal | e3175d3 | 2016-08-31 17:50:11 +0530 | [diff] [blame] | 436 | /** |
| 437 | * Returns attribute in constructor for yang augmented info map. |
| 438 | * |
| 439 | * @return attribute in constructor for yang augmented info map |
| 440 | */ |
| 441 | static String getYangAugmentedMapObjectForConstruct() { |
| 442 | return " this.yangAugmentedInfoMap = builderObject.yangAugmentedInfoMap();\n"; |
| 443 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 444 | } |