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 | |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 19 | import org.onosproject.yangutils.datamodel.YangCompilerAnnotation; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 20 | import org.onosproject.yangutils.datamodel.YangNode; |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 23 | import org.onosproject.yangutils.translator.tojava.JavaQualifiedTypeInfoTranslator; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 24 | import org.onosproject.yangutils.translator.tojava.TempJavaServiceFragmentFiles; |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 25 | import org.onosproject.yangutils.utils.UtilConstants.Operation; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 26 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 27 | import java.util.List; |
| 28 | |
| 29 | import static java.util.Collections.sort; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 30 | import static org.onosproject.yangutils.translator.tojava.utils.BracketType.OPEN_CLOSE_BRACKET; |
| 31 | import static org.onosproject.yangutils.translator.tojava.utils.BracketType.OPEN_CLOSE_BRACKET_WITH_VALUE; |
| 32 | import static org.onosproject.yangutils.translator.tojava.utils.BracketType.OPEN_CLOSE_DIAMOND; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getEnumJavaAttribute; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 34 | import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.brackets; |
| 35 | import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getDefaultDefinition; |
| 36 | import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getImportString; |
| 37 | import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.signatureClose; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.utils.UtilConstants.ARRAY_LIST; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.utils.UtilConstants.CLASS_STRING; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 40 | import static org.onosproject.yangutils.utils.UtilConstants.COMMA; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 41 | import static org.onosproject.yangutils.utils.UtilConstants.DIAMOND_CLOSE_BRACKET; |
| 42 | import static org.onosproject.yangutils.utils.UtilConstants.DIAMOND_OPEN_BRACKET; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 43 | import static org.onosproject.yangutils.utils.UtilConstants.EIGHT_SPACE_INDENTATION; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 44 | import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 45 | import static org.onosproject.yangutils.utils.UtilConstants.ENUM; |
Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 46 | import static org.onosproject.yangutils.utils.UtilConstants.EQUAL; |
| 47 | import static org.onosproject.yangutils.utils.UtilConstants.FOUR_SPACE_INDENTATION; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 48 | import static org.onosproject.yangutils.utils.UtilConstants.HASH_MAP; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 49 | import static org.onosproject.yangutils.utils.UtilConstants.INT; |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 50 | import static org.onosproject.yangutils.utils.UtilConstants.INT_MAX_RANGE_ATTR; |
| 51 | import static org.onosproject.yangutils.utils.UtilConstants.INT_MIN_RANGE_ATTR; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 52 | import static org.onosproject.yangutils.utils.UtilConstants.LIST; |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 53 | import static org.onosproject.yangutils.utils.UtilConstants.LONG_MAX_RANGE_ATTR; |
| 54 | import static org.onosproject.yangutils.utils.UtilConstants.LONG_MIN_RANGE_ATTR; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 55 | import static org.onosproject.yangutils.utils.UtilConstants.MAP; |
| 56 | import static org.onosproject.yangutils.utils.UtilConstants.NEW; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 57 | import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 58 | import static org.onosproject.yangutils.utils.UtilConstants.OBJECT_STRING; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 59 | import static org.onosproject.yangutils.utils.UtilConstants.PERIOD; |
| 60 | import static org.onosproject.yangutils.utils.UtilConstants.PRIVATE; |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 61 | import static org.onosproject.yangutils.utils.UtilConstants.PROTECTED; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 62 | import static org.onosproject.yangutils.utils.UtilConstants.PUBLIC; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 63 | import static org.onosproject.yangutils.utils.UtilConstants.QUESTION_MARK; |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 64 | import static org.onosproject.yangutils.utils.UtilConstants.QUEUE; |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 65 | import static org.onosproject.yangutils.utils.UtilConstants.QUOTES; |
| 66 | import static org.onosproject.yangutils.utils.UtilConstants.SCHEMA_NAME; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 67 | import static org.onosproject.yangutils.utils.UtilConstants.SEMI_COLON; |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 68 | import static org.onosproject.yangutils.utils.UtilConstants.SET; |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 69 | import static org.onosproject.yangutils.utils.UtilConstants.SHORT_MAX_RANGE_ATTR; |
| 70 | import static org.onosproject.yangutils.utils.UtilConstants.SHORT_MIN_RANGE_ATTR; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 71 | import static org.onosproject.yangutils.utils.UtilConstants.SPACE; |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 72 | import static org.onosproject.yangutils.utils.UtilConstants.STRING_DATA_TYPE; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 73 | import static org.onosproject.yangutils.utils.UtilConstants.TYPE; |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 74 | import static org.onosproject.yangutils.utils.UtilConstants.UINT8_MAX_RANGE_ATTR; |
| 75 | import static org.onosproject.yangutils.utils.UtilConstants.UINT8_MIN_RANGE_ATTR; |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 76 | import static org.onosproject.yangutils.utils.UtilConstants.UINT_MAX_RANGE_ATTR; |
| 77 | import static org.onosproject.yangutils.utils.UtilConstants.UINT_MIN_RANGE_ATTR; |
| 78 | import static org.onosproject.yangutils.utils.UtilConstants.ULONG_MAX_RANGE_ATTR; |
| 79 | import static org.onosproject.yangutils.utils.UtilConstants.ULONG_MIN_RANGE_ATTR; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 80 | import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUGMENTED_INFO_LOWER_CASE; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 81 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.ENUM_ATTRIBUTE; |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 82 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.enumJavaDocForInnerClass; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 83 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 84 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.trimAtLast; |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 85 | |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 86 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 87 | * Represents utility class to generate the java snippet. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 88 | */ |
| 89 | public final class JavaCodeSnippetGen { |
| 90 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 91 | // No instantiation. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 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 | /** |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 109 | * Returns the textual java code information corresponding to the import |
| 110 | * list. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 111 | * |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 112 | * @param importInfo import info |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 113 | * @return the textual java code information corresponding to the import |
| 114 | * list |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 115 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 116 | static String getImportText(JavaQualifiedTypeInfoTranslator importInfo) { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 117 | return getImportString(importInfo.getPkgInfo(), importInfo |
| 118 | .getClassInfo()); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 122 | * Returns the textual java code for attribute definition in class. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 123 | * |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 124 | * @param typePkg Package of the attribute type |
| 125 | * @param attrType java attribute type |
| 126 | * @param attrName name of the attribute |
| 127 | * @param isList is list attribute |
| 128 | * @param accessType attribute access type |
| 129 | * @param annotation compiler annotation |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 130 | * @return the textual java code for attribute definition in class |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 131 | */ |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 132 | public static String getJavaAttributeDefinition(String typePkg, |
| 133 | String attrType, |
| 134 | String attrName, |
| 135 | boolean isList, |
| 136 | String accessType, |
| 137 | YangCompilerAnnotation annotation) { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 138 | StringBuilder attrDef = new StringBuilder(FOUR_SPACE_INDENTATION); |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 139 | attrDef.append(accessType).append(SPACE); |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 140 | |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 141 | if (!isList) { |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 142 | if (typePkg != null) { |
| 143 | attrDef.append(typePkg).append(PERIOD); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 144 | } |
| 145 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 146 | attrDef.append(attrType).append(SPACE) |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 147 | .append(attrName).append(SEMI_COLON) |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 148 | .append(NEW_LINE); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 149 | } else { |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 150 | // Add starting definition. |
| 151 | addAttrStartDef(annotation, attrDef); |
| 152 | |
| 153 | if (typePkg != null) { |
| 154 | attrDef.append(typePkg).append(PERIOD); |
Vidyashree Rama | b367047 | 2016-08-06 15:49:56 +0530 | [diff] [blame] | 155 | } |
| 156 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 157 | attrDef.append(attrType); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 158 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 159 | // Add ending definition. |
| 160 | addAttrEndDef(annotation, attrDef, attrName); |
Bharat saraswal | 5e3c45c | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 161 | } |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 162 | return attrDef.toString(); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 163 | } |
| 164 | |
| 165 | /** |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 166 | * Adds starting attribute definition. |
| 167 | * |
| 168 | * @param annotation compiler annotation |
| 169 | * @param attrDef JAVA attribute definition |
| 170 | */ |
| 171 | private static void addAttrStartDef(YangCompilerAnnotation annotation, |
| 172 | StringBuilder attrDef) { |
| 173 | if (annotation != null && |
| 174 | annotation.getYangAppDataStructure() != null) { |
| 175 | switch (annotation.getYangAppDataStructure().getDataStructure()) { |
| 176 | case QUEUE: { |
| 177 | attrDef.append(QUEUE) |
| 178 | .append(DIAMOND_OPEN_BRACKET); |
| 179 | break; |
| 180 | } |
| 181 | case SET: { |
| 182 | attrDef.append(SET) |
| 183 | .append(DIAMOND_OPEN_BRACKET); |
| 184 | break; |
| 185 | } |
| 186 | default: { |
| 187 | attrDef.append(LIST) |
| 188 | .append(DIAMOND_OPEN_BRACKET); |
| 189 | } |
| 190 | } |
| 191 | } else { |
| 192 | attrDef.append(LIST).append(DIAMOND_OPEN_BRACKET); |
| 193 | } |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * Adds ending attribute definition. |
| 198 | * |
| 199 | * @param annotation compiler annotation |
| 200 | * @param attrDef JAVA attribute definition |
| 201 | * @param attrName name of attribute |
| 202 | */ |
| 203 | private static void addAttrEndDef(YangCompilerAnnotation annotation, |
| 204 | StringBuilder attrDef, String attrName) { |
| 205 | if (annotation != null && |
| 206 | annotation.getYangAppDataStructure() != null) { |
| 207 | attrDef.append(DIAMOND_CLOSE_BRACKET).append(SPACE) |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 208 | .append(attrName).append(SEMI_COLON) |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 209 | .append(NEW_LINE); |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 210 | } else { |
| 211 | attrDef.append(DIAMOND_CLOSE_BRACKET).append(SPACE).append(attrName) |
| 212 | .append(SPACE).append(EQUAL).append(SPACE).append(NEW) |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 213 | .append(SPACE).append(ARRAY_LIST).append(SEMI_COLON) |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 214 | .append(NEW_LINE); |
| 215 | } |
| 216 | } |
| 217 | |
| 218 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 219 | * Returns string for enum's attribute. |
| 220 | * |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 221 | * @param name name of attribute |
| 222 | * @param value value of the enum |
| 223 | * @return string for enum's attribute |
| 224 | */ |
| 225 | public static String generateEnumAttributeString(String name, int value) { |
| 226 | String enumName = getEnumJavaAttribute(name); |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 227 | return enumJavaDocForInnerClass(name) + EIGHT_SPACE_INDENTATION + |
| 228 | enumName.toUpperCase() + brackets(OPEN_CLOSE_BRACKET_WITH_VALUE, |
| 229 | value + EMPTY_STRING, null) + |
| 230 | COMMA + NEW_LINE; |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 231 | } |
| 232 | |
| 233 | /** |
| 234 | * Returns string for enum's attribute for enum class. |
| 235 | * |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 236 | * @param name name of attribute |
| 237 | * @param value value of the enum |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 238 | * @return string for enum's attribute |
| 239 | */ |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 240 | public static String generateEnumAttributeStringWithSchemaName( |
| 241 | String name, int value) { |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 242 | String enumName = getEnumJavaAttribute(name); |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 243 | String str = value + COMMA + SPACE + QUOTES + name + QUOTES; |
| 244 | return getJavaDoc(ENUM_ATTRIBUTE, name, false, null) + |
| 245 | FOUR_SPACE_INDENTATION + enumName.toUpperCase() + brackets( |
| 246 | OPEN_CLOSE_BRACKET_WITH_VALUE, str, null) + COMMA + NEW_LINE; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 247 | } |
| 248 | |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 249 | /** |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 250 | * Returns sorted import list. |
| 251 | * |
| 252 | * @param imports import list |
| 253 | * @return sorted import list |
| 254 | */ |
| 255 | public static List<String> sortImports(List<String> imports) { |
| 256 | sort(imports); |
| 257 | return imports; |
| 258 | } |
| 259 | |
| 260 | /** |
| 261 | * Returns event enum start. |
| 262 | * |
| 263 | * @return event enum start |
| 264 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 265 | static String getEventEnumTypeStart() { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 266 | return NEW_LINE + FOUR_SPACE_INDENTATION + |
| 267 | getDefaultDefinition(ENUM, TYPE, PUBLIC); |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 268 | } |
| 269 | |
| 270 | /** |
| 271 | * Adds listener's imports. |
| 272 | * |
| 273 | * @param curNode currentYangNode. |
| 274 | * @param imports import list |
| 275 | * @param operation add or remove |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 276 | */ |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 277 | public static void addListenersImport(YangNode curNode, |
| 278 | List<String> imports, |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 279 | Operation operation) { |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 280 | String thisImport; |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 281 | TempJavaServiceFragmentFiles tempFiles = |
| 282 | ((JavaCodeGeneratorInfo) curNode).getTempJavaCodeFragmentFiles() |
| 283 | .getServiceTempFiles(); |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 284 | thisImport = tempFiles.getJavaImportData().getListenerServiceImport(); |
| 285 | performOperationOnImports(imports, thisImport, operation); |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Performs given operations on import list. |
| 290 | * |
| 291 | * @param imports list of imports |
| 292 | * @param curImport current import |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 293 | * @param operation ADD or REMOVE |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 294 | * @return import list |
| 295 | */ |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 296 | private static List<String> performOperationOnImports(List<String> imports, |
| 297 | String curImport, |
| 298 | Operation operation) { |
| 299 | switch (operation) { |
| 300 | case ADD: |
| 301 | imports.add(curImport); |
| 302 | break; |
| 303 | case REMOVE: |
| 304 | imports.remove(curImport); |
| 305 | break; |
| 306 | default: |
| 307 | throw new TranslatorException("Invalid operation type"); |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 308 | } |
| 309 | sortImports(imports); |
| 310 | return imports; |
| 311 | } |
| 312 | |
| 313 | /** |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 314 | * Returns integer attribute for enum's class to get the values. |
| 315 | * |
| 316 | * @param className enum's class name |
| 317 | * @return enum's attribute |
| 318 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 319 | static String getEnumsValueAttribute(String className) { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 320 | return getJavaAttributeDefinition(null, INT, className, |
| 321 | false, PRIVATE, null) + |
| 322 | getJavaAttributeDefinition(null, STRING_DATA_TYPE, SCHEMA_NAME, |
| 323 | false, PRIVATE, null); |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 324 | } |
| 325 | |
| 326 | /** |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 327 | * Returns attribute for augmentation. |
| 328 | * |
| 329 | * @return attribute for augmentation |
| 330 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 331 | static String addAugmentationAttribute() { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 332 | String[] array = {NEW_LINE, SEMI_COLON}; |
| 333 | return trimAtLast(getJavaAttributeDefinition( |
| 334 | null, getAugmentMapTypeString(), |
| 335 | YANG_AUGMENTED_INFO_LOWER_CASE + MAP, false, PROTECTED, |
| 336 | null), array) + SPACE + EQUAL + SPACE + NEW + SPACE + |
| 337 | HASH_MAP + brackets(OPEN_CLOSE_DIAMOND, null, null) + brackets( |
| 338 | OPEN_CLOSE_BRACKET, null, null) + signatureClose(); |
| 339 | } |
| 340 | |
| 341 | /** |
| 342 | * Returns augment map return type. |
| 343 | * |
| 344 | * @return augment map return type |
| 345 | */ |
| 346 | static String getAugmentMapTypeString() { |
| 347 | return MAP + DIAMOND_OPEN_BRACKET + CLASS_STRING + DIAMOND_OPEN_BRACKET + |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 348 | QUESTION_MARK + DIAMOND_CLOSE_BRACKET + COMMA + SPACE + |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 349 | OBJECT_STRING + DIAMOND_CLOSE_BRACKET; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 350 | } |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 351 | |
| 352 | /** |
| 353 | * Adds attribute for int ranges. |
| 354 | * |
| 355 | * @param modifier modifier for attribute |
| 356 | * @param addFirst true if int need to be added fist. |
| 357 | * @return attribute for int ranges |
| 358 | */ |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 359 | static String addStaticAttributeIntRange(String modifier, |
| 360 | boolean addFirst) { |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 361 | if (addFirst) { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 362 | return getTypeConflictAttributeStrings(modifier, |
| 363 | INT_MIN_RANGE_ATTR, |
| 364 | INT_MAX_RANGE_ATTR); |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 365 | } |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 366 | return getTypeConflictAttributeStrings(modifier, |
| 367 | UINT_MIN_RANGE_ATTR, |
| 368 | UINT_MAX_RANGE_ATTR); |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 369 | } |
| 370 | |
| 371 | /** |
| 372 | * Adds attribute for long ranges. |
| 373 | * |
| 374 | * @param modifier modifier for attribute |
| 375 | * @param addFirst if need to be added first |
| 376 | * @return attribute for long ranges |
| 377 | */ |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 378 | static String addStaticAttributeLongRange(String modifier, |
| 379 | boolean addFirst) { |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 380 | if (addFirst) { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 381 | return getTypeConflictAttributeStrings(modifier, |
| 382 | LONG_MIN_RANGE_ATTR, |
| 383 | LONG_MAX_RANGE_ATTR); |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 384 | } |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 385 | return getTypeConflictAttributeStrings(modifier, |
| 386 | ULONG_MIN_RANGE_ATTR, |
| 387 | ULONG_MAX_RANGE_ATTR); |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 388 | } |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 389 | |
| 390 | /** |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 391 | * Adds attribute for long ranges. |
| 392 | * |
| 393 | * @param modifier modifier for attribute |
| 394 | * @param addFirst if need to be added first |
| 395 | * @return attribute for long ranges |
| 396 | */ |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 397 | static String addStaticAttributeShortRange(String modifier, |
| 398 | boolean addFirst) { |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 399 | if (addFirst) { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 400 | return getTypeConflictAttributeStrings(modifier, |
| 401 | SHORT_MIN_RANGE_ATTR, |
| 402 | SHORT_MAX_RANGE_ATTR); |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 403 | } |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 404 | return getTypeConflictAttributeStrings(modifier, |
| 405 | UINT8_MIN_RANGE_ATTR, |
| 406 | UINT8_MAX_RANGE_ATTR); |
| 407 | } |
| 408 | |
| 409 | /** |
| 410 | * Returns attribute for conflicting type in union. |
| 411 | * |
| 412 | * @param modifier modifier |
| 413 | * @param attr1 attribute one |
| 414 | * @param att2 attribute two |
| 415 | * @return attribute for conflicting type in union |
| 416 | */ |
| 417 | private static String getTypeConflictAttributeStrings(String modifier, |
| 418 | String attr1, |
| 419 | String att2) { |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 420 | return NEW_LINE + FOUR_SPACE_INDENTATION + modifier + SPACE + |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 421 | attr1 + FOUR_SPACE_INDENTATION + modifier + |
| 422 | SPACE + att2; |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 423 | } |
| 424 | |
| 425 | /** |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 426 | * Returns operation type enum. |
| 427 | * |
| 428 | * @return operation type enum |
| 429 | */ |
| 430 | static String getOperationTypeEnum() { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 431 | return " /**\n" + |
| 432 | " * Specify the node specific operation in protocols " + |
| 433 | "like NETCONF.\n" + |
| 434 | " * Applicable in protocol edit operation, not applicable" + |
| 435 | " in query operation\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 436 | " */\n" + |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 437 | " public enum OnosYangNodeOperationType {\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 438 | " MERGE,\n" + |
| 439 | " REPLACE,\n" + |
| 440 | " CREATE,\n" + |
| 441 | " DELETE,\n" + |
VinodKumarS-Huawei | 8f16422 | 2016-08-31 15:47:30 +0530 | [diff] [blame] | 442 | " REMOVE,\n" + |
| 443 | " NONE\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 444 | " }\n"; |
| 445 | } |
| 446 | |
| 447 | /** |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 448 | * Returns operation type enum, leaf value set attribute and select leaf |
| 449 | * attribute. |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 450 | * |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 451 | * @return operation attributes for value and select leaf flags |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 452 | */ |
| 453 | static String getOperationAttributes() { |
| 454 | return " /**\n" + |
| 455 | " * Identify the leafs whose value are explicitly set\n" + |
| 456 | " * Applicable in protocol edit and query operation\n" + |
| 457 | " */\n" + |
Gaurav Agrawal | 8a14752 | 2016-08-10 13:43:01 +0530 | [diff] [blame] | 458 | " private BitSet valueLeafFlags = new BitSet();\n" + |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 459 | "\n" + |
| 460 | " /**\n" + |
| 461 | " * Identify the leafs to be selected, in a query operation\n" + |
| 462 | " */\n" + |
Gaurav Agrawal | 8a14752 | 2016-08-10 13:43:01 +0530 | [diff] [blame] | 463 | " private BitSet selectLeafFlags = new BitSet();\n"; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 464 | } |
| 465 | |
| 466 | /** |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 467 | * Returns operation type enum, leaf value set attribute and select leaf |
| 468 | * attribute for constructor. |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 469 | * |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 470 | * @return operation attributes for constructor |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 471 | */ |
| 472 | static String getOperationAttributeForConstructor() { |
Gaurav Agrawal | 8a14752 | 2016-08-10 13:43:01 +0530 | [diff] [blame] | 473 | return " this.valueLeafFlags = builderObject.getValueLeafFlags();\n" + |
| 474 | " this.selectLeafFlags = builderObject.getSelectLeafFlags();\n"; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 475 | } |
| 476 | |
| 477 | /** |
Bharat saraswal | e3175d3 | 2016-08-31 17:50:11 +0530 | [diff] [blame] | 478 | * Returns attribute in constructor for yang augmented info map. |
| 479 | * |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 480 | * @return augment info map |
Bharat saraswal | e3175d3 | 2016-08-31 17:50:11 +0530 | [diff] [blame] | 481 | */ |
| 482 | static String getYangAugmentedMapObjectForConstruct() { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 483 | return " this.yangAugmentedInfoMap = builderObject" + |
| 484 | ".yangAugmentedInfoMap();\n"; |
Bharat saraswal | e3175d3 | 2016-08-31 17:50:11 +0530 | [diff] [blame] | 485 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 486 | } |