Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Bharat saraswal | 870c56f | 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.utils.io.impl; |
| 18 | |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 19 | import static org.onosproject.yangutils.utils.UtilConstants.AUGMENTED; |
| 20 | import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUGMENTED_INFO; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 21 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER; |
| 22 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER_CLASS_JAVA_DOC; |
Shankara-Huawei | b9999eb | 2016-07-14 16:53:09 +0530 | [diff] [blame^] | 23 | import static org.onosproject.yangutils.utils.UtilConstants.OP_PARAM_JAVA_DOC; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 24 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER_INTERFACE_JAVA_DOC; |
| 25 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER_OBJECT; |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 26 | import static org.onosproject.yangutils.utils.UtilConstants.CLASS; |
Bharat saraswal | cad0e65 | 2016-05-26 23:48:38 +0530 | [diff] [blame] | 27 | import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING; |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 28 | import static org.onosproject.yangutils.utils.UtilConstants.ENUM_ATTRIBUTE_JAVADOC; |
| 29 | import static org.onosproject.yangutils.utils.UtilConstants.ENUM_CLASS_JAVADOC; |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 30 | import static org.onosproject.yangutils.utils.UtilConstants.EVENT_JAVA_DOC; |
| 31 | import static org.onosproject.yangutils.utils.UtilConstants.EVENT_LISTENER_JAVA_DOC; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 32 | import static org.onosproject.yangutils.utils.UtilConstants.FOUR_SPACE_INDENTATION; |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.utils.UtilConstants.FROM_STRING_METHOD_NAME; |
| 34 | import static org.onosproject.yangutils.utils.UtilConstants.FROM_STRING_PARAM_NAME; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 35 | import static org.onosproject.yangutils.utils.UtilConstants.IMPL; |
| 36 | import static org.onosproject.yangutils.utils.UtilConstants.IMPL_CLASS_JAVA_DOC; |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.utils.UtilConstants.INPUT; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.utils.UtilConstants.INTERFACE_JAVA_DOC; |
| 39 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_BUILD; |
| 40 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_BUILD_RETURN; |
| 41 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_CONSTRUCTOR; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 42 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_END_LINE; |
| 43 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_FIRST_LINE; |
| 44 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_GETTERS; |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 45 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_MANAGER_SETTERS; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 46 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_OF; |
| 47 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_PARAM; |
| 48 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_RETURN; |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 49 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_RPC; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 50 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_SETTERS; |
| 51 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_SETTERS_COMMON; |
| 52 | import static org.onosproject.yangutils.utils.UtilConstants.LIST; |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 53 | import static org.onosproject.yangutils.utils.UtilConstants.MAP; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 54 | import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE; |
Bharat saraswal | 2f11f65 | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 55 | import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE_ASTERISK; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 56 | import static org.onosproject.yangutils.utils.UtilConstants.OBJECT; |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 57 | import static org.onosproject.yangutils.utils.UtilConstants.OBJECT_STRING; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 58 | import static org.onosproject.yangutils.utils.UtilConstants.OF; |
| 59 | import static org.onosproject.yangutils.utils.UtilConstants.PACKAGE_INFO_JAVADOC; |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 60 | import static org.onosproject.yangutils.utils.UtilConstants.PACKAGE_INFO_JAVADOC_OF_CHILD; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 61 | import static org.onosproject.yangutils.utils.UtilConstants.PERIOD; |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 62 | import static org.onosproject.yangutils.utils.UtilConstants.RPC_INPUT_STRING; |
| 63 | import static org.onosproject.yangutils.utils.UtilConstants.RPC_OUTPUT_STRING; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 64 | import static org.onosproject.yangutils.utils.UtilConstants.SPACE; |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 65 | import static org.onosproject.yangutils.utils.UtilConstants.STRING_DATA_TYPE; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 66 | import static org.onosproject.yangutils.utils.UtilConstants.VALUE; |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 67 | import static org.onosproject.yangutils.utils.UtilConstants.VOID; |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 68 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getCamelCase; |
| 69 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getSmallCase; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 70 | |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 71 | /** |
Bharat saraswal | d9822e9 | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 72 | * Represents javadoc for the generated classes. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 73 | */ |
| 74 | public final class JavaDocGen { |
| 75 | |
| 76 | /** |
Bharat saraswal | d9822e9 | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 77 | * Creates an instance of java doc gen. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 78 | */ |
| 79 | private JavaDocGen() { |
| 80 | } |
| 81 | |
| 82 | /** |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 83 | * Returns java docs. |
| 84 | * |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 85 | * @param type java doc type |
| 86 | * @param name name of the YangNode |
| 87 | * @param isList is list attribute |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 88 | * @param pluginConfig plugin configurations |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 89 | * @return javadocs. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 90 | */ |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 91 | public static String getJavaDoc(JavaDocType type, String name, boolean isList, YangPluginConfig pluginConfig) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 92 | |
Gaurav Agrawal | 8a5af14 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 93 | name = YangIoUtils.getSmallCase(getCamelCase(name, pluginConfig.getConflictResolver())); |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 94 | switch (type) { |
| 95 | case IMPL_CLASS: { |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 96 | return generateForClass(name); |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 97 | } |
| 98 | case BUILDER_CLASS: { |
| 99 | return generateForBuilderClass(name); |
| 100 | } |
Shankara-Huawei | b9999eb | 2016-07-14 16:53:09 +0530 | [diff] [blame^] | 101 | case OPERATION_CLASS: { |
| 102 | return generateForOpParamClass(name); |
| 103 | } |
| 104 | case OPERATION_BUILDER_CLASS: { |
| 105 | return generateForOpParamClass(name); |
| 106 | } |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 107 | case INTERFACE: { |
| 108 | return generateForInterface(name); |
| 109 | } |
| 110 | case BUILDER_INTERFACE: { |
| 111 | return generateForBuilderInterface(name); |
| 112 | } |
| 113 | case PACKAGE_INFO: { |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 114 | return generateForPackage(name, isList); |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 115 | } |
| 116 | case GETTER_METHOD: { |
| 117 | return generateForGetters(name, isList); |
| 118 | } |
| 119 | case TYPE_DEF_SETTER_METHOD: { |
| 120 | return generateForTypeDefSetter(name); |
| 121 | } |
| 122 | case SETTER_METHOD: { |
| 123 | return generateForSetters(name, isList); |
| 124 | } |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 125 | case MANAGER_SETTER_METHOD: { |
| 126 | return generateForManagerSetters(name, isList); |
| 127 | } |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 128 | case OF_METHOD: { |
| 129 | return generateForOf(name); |
| 130 | } |
| 131 | case DEFAULT_CONSTRUCTOR: { |
| 132 | return generateForDefaultConstructors(name); |
| 133 | } |
| 134 | case BUILD_METHOD: { |
| 135 | return generateForBuild(name); |
| 136 | } |
| 137 | case TYPE_CONSTRUCTOR: { |
| 138 | return generateForTypeConstructor(name); |
| 139 | } |
| 140 | case FROM_METHOD: { |
| 141 | return generateForFromString(name); |
| 142 | } |
| 143 | case ENUM_CLASS: { |
| 144 | return generateForEnum(name); |
| 145 | } |
| 146 | case ENUM_ATTRIBUTE: { |
| 147 | return generateForEnumAttr(name); |
| 148 | } |
| 149 | case RPC_INTERFACE: { |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 150 | return generateForRpcService(name); |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 151 | } |
| 152 | case RPC_MANAGER: { |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 153 | return generateForClass(name); |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 154 | } |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 155 | case EVENT: { |
| 156 | return generateForEvent(name); |
| 157 | } |
| 158 | case EVENT_LISTENER: { |
| 159 | return generateForEventListener(name); |
| 160 | } |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 161 | case EVENT_SUBJECT_CLASS: { |
| 162 | return generateForClass(name); |
| 163 | } |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 164 | default: { |
| 165 | return generateForConstructors(name); |
| 166 | } |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 167 | } |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 168 | } |
| 169 | |
| 170 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 171 | * Generates javaDocs for enum's attributes. |
| 172 | * |
| 173 | * @param name attribute name |
| 174 | * @return javaDocs |
| 175 | */ |
| 176 | private static String generateForEnumAttr(String name) { |
| 177 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + ENUM_ATTRIBUTE_JAVADOC |
| 178 | + name + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
| 179 | } |
| 180 | |
| 181 | /** |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 182 | * Generates javaDocs for rpc method. |
| 183 | * |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 184 | * @param rpcName name of the rpc |
| 185 | * @param inputName name of input |
| 186 | * @param outputName name of output |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 187 | * @param pluginConfig plugin configurations |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 188 | * @return javaDocs of rpc method |
| 189 | */ |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 190 | public static String generateJavaDocForRpc(String rpcName, String inputName, String outputName, |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 191 | YangPluginConfig pluginConfig) { |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 192 | rpcName = getCamelCase(rpcName, pluginConfig.getConflictResolver()); |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 193 | |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 194 | String javadoc = |
| 195 | NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_RPC |
Bharat saraswal | cad0e65 | 2016-05-26 23:48:38 +0530 | [diff] [blame] | 196 | + rpcName + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK; |
| 197 | if (!inputName.equals(EMPTY_STRING)) { |
| 198 | javadoc = javadoc + getInputString(inputName, rpcName); |
| 199 | } |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 200 | if (!outputName.equals(VOID)) { |
| 201 | javadoc = javadoc + getOutputString(outputName, rpcName); |
| 202 | } |
| 203 | return javadoc + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 204 | } |
| 205 | |
| 206 | /** |
| 207 | * Returns output string of rpc. |
| 208 | * |
| 209 | * @param outputName name of output |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 210 | * @param rpcName name of rpc |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 211 | * @return javaDocs for output string of rpc |
| 212 | */ |
| 213 | private static String getOutputString(String outputName, String rpcName) { |
| 214 | return FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + outputName + SPACE + RPC_OUTPUT_STRING + rpcName + NEW_LINE; |
| 215 | } |
| 216 | |
| 217 | /** |
| 218 | * Returns input string of rpc. |
| 219 | * |
| 220 | * @param inputName name of input |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 221 | * @param rpcName name of rpc |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 222 | * @return javaDocs for input string of rpc |
| 223 | */ |
| 224 | private static String getInputString(String inputName, String rpcName) { |
| 225 | if (inputName.equals("")) { |
| 226 | return null; |
| 227 | } else { |
| 228 | return FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + inputName + SPACE + RPC_INPUT_STRING + rpcName + NEW_LINE; |
| 229 | } |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Generates javaDoc for the interface. |
| 234 | * |
| 235 | * @param interfaceName interface name |
| 236 | * @return javaDocs |
| 237 | */ |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 238 | private static String generateForRpcService(String interfaceName) { |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 239 | return NEW_LINE + JAVA_DOC_FIRST_LINE + INTERFACE_JAVA_DOC + interfaceName + PERIOD + NEW_LINE |
| 240 | + JAVA_DOC_END_LINE; |
| 241 | } |
| 242 | |
| 243 | /** |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 244 | * Generates javaDoc for the event. |
| 245 | * |
| 246 | * @param eventClassName event class name |
| 247 | * @return javaDocs |
| 248 | */ |
| 249 | private static String generateForEvent(String eventClassName) { |
| 250 | return NEW_LINE + JAVA_DOC_FIRST_LINE + EVENT_JAVA_DOC + eventClassName + PERIOD + NEW_LINE |
| 251 | + JAVA_DOC_END_LINE; |
| 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Generates javaDoc for the event listener. |
| 256 | * |
| 257 | * @param eventListenerInterfaceName event class name |
| 258 | * @return javaDocs |
| 259 | */ |
| 260 | private static String generateForEventListener(String eventListenerInterfaceName) { |
| 261 | return NEW_LINE + JAVA_DOC_FIRST_LINE + EVENT_LISTENER_JAVA_DOC + eventListenerInterfaceName |
| 262 | + PERIOD + NEW_LINE + JAVA_DOC_END_LINE; |
| 263 | } |
| 264 | |
| 265 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 266 | * Generates javaDocs for getter method. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 267 | * |
| 268 | * @param attribute attribute |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 269 | * @param isList is list attribute |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 270 | * @return javaDocs |
| 271 | */ |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 272 | private static String generateForGetters(String attribute, boolean isList) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 273 | |
| 274 | String getter = NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION |
Bharat saraswal | 2f11f65 | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 275 | + JAVA_DOC_GETTERS + attribute + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 276 | + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 277 | if (isList) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 278 | String listAttribute = LIST.toLowerCase() + SPACE + OF + SPACE; |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 279 | getter = getter + listAttribute; |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 280 | } else { |
| 281 | getter = getter + VALUE + SPACE + OF + SPACE; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 282 | } |
| 283 | |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 284 | getter = getter + attribute + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 285 | return getter; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Generates javaDocs for setter method. |
| 290 | * |
| 291 | * @param attribute attribute |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 292 | * @param isList is list attribute |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 293 | * @return javaDocs |
| 294 | */ |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 295 | private static String generateForSetters(String attribute, boolean isList) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 296 | |
| 297 | String setter = NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION |
Bharat saraswal | 2f11f65 | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 298 | + JAVA_DOC_SETTERS + attribute + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 299 | + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + attribute + SPACE; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 300 | if (isList) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 301 | String listAttribute = LIST.toLowerCase() + SPACE + OF + SPACE; |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 302 | setter = setter + listAttribute; |
| 303 | } else { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 304 | setter = setter + VALUE + SPACE + OF + SPACE; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 305 | } |
Bharat saraswal | cad0e65 | 2016-05-26 23:48:38 +0530 | [diff] [blame] | 306 | setter = setter + attribute + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + BUILDER_OBJECT |
| 307 | + attribute |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 308 | + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 309 | return setter; |
| 310 | } |
| 311 | |
| 312 | /** |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 313 | * Generates javaDocs for setter method. |
| 314 | * |
| 315 | * @param attribute attribute |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 316 | * @param isList is list attribute |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 317 | * @return javaDocs |
| 318 | */ |
| 319 | private static String generateForManagerSetters(String attribute, boolean isList) { |
| 320 | |
| 321 | String setter = NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION |
| 322 | + JAVA_DOC_MANAGER_SETTERS + attribute + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK |
| 323 | + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + attribute + SPACE; |
| 324 | if (isList) { |
| 325 | String listAttribute = LIST.toLowerCase() + SPACE + OF + SPACE; |
| 326 | setter = setter + listAttribute; |
| 327 | } else { |
| 328 | setter = setter + VALUE + SPACE + OF + SPACE; |
| 329 | } |
| 330 | setter = setter + attribute |
| 331 | + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
| 332 | return setter; |
| 333 | } |
| 334 | |
| 335 | /** |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 336 | * Generates javaDocs for of method. |
| 337 | * |
| 338 | * @param attribute attribute |
| 339 | * @return javaDocs |
| 340 | */ |
| 341 | private static String generateForOf(String attribute) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 342 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_OF |
Bharat saraswal | 2f11f65 | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 343 | + attribute + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 344 | + JAVA_DOC_PARAM + VALUE + SPACE + VALUE + SPACE + OF + SPACE + attribute + NEW_LINE |
| 345 | + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + OBJECT + SPACE + OF + SPACE + attribute + NEW_LINE |
| 346 | + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 347 | } |
| 348 | |
| 349 | /** |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 350 | * Generates javaDocs for from method. |
| 351 | * |
| 352 | * @param attribute attribute |
| 353 | * @return javaDocs |
| 354 | */ |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 355 | private static String generateForFromString(String attribute) { |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 356 | |
| 357 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_OF |
| 358 | + attribute + SPACE + FROM_STRING_METHOD_NAME + SPACE + INPUT + SPACE + STRING_DATA_TYPE + PERIOD |
| 359 | + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 360 | + FROM_STRING_PARAM_NAME + SPACE + INPUT + SPACE + STRING_DATA_TYPE + NEW_LINE |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 361 | + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + OBJECT + SPACE + OF + SPACE + attribute + NEW_LINE |
| 362 | + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
| 363 | } |
| 364 | |
| 365 | /** |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 366 | * Generates javaDocs for typedef setter method. |
| 367 | * |
| 368 | * @param attribute attribute |
| 369 | * @return javaDocs |
| 370 | */ |
| 371 | private static String generateForTypeDefSetter(String attribute) { |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 372 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION |
Bharat saraswal | 2f11f65 | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 373 | + JAVA_DOC_SETTERS_COMMON + attribute + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 374 | + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + VALUE + SPACE + VALUE + SPACE + OF + SPACE + attribute |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 375 | + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 376 | } |
| 377 | |
| 378 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 379 | * Generates javaDocs for the impl class. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 380 | * |
| 381 | * @param className class name |
Vinod Kumar S | c421600 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 382 | * @return javaDocs |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 383 | */ |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 384 | private static String generateForClass(String className) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 385 | return NEW_LINE + JAVA_DOC_FIRST_LINE + IMPL_CLASS_JAVA_DOC + className + PERIOD + NEW_LINE + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 386 | } |
| 387 | |
| 388 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 389 | * Generates javaDocs for enum. |
| 390 | * |
| 391 | * @param className enum class name |
| 392 | * @return javaDocs |
| 393 | */ |
| 394 | private static String generateForEnum(String className) { |
| 395 | return NEW_LINE + NEW_LINE + JAVA_DOC_FIRST_LINE + ENUM_CLASS_JAVADOC + className + PERIOD + NEW_LINE |
| 396 | + JAVA_DOC_END_LINE; |
| 397 | } |
| 398 | |
| 399 | /** |
| 400 | * Generates javaDocs for the builder class. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 401 | * |
| 402 | * @param className class name |
Vinod Kumar S | c421600 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 403 | * @return javaDocs |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 404 | */ |
| 405 | private static String generateForBuilderClass(String className) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 406 | return NEW_LINE + JAVA_DOC_FIRST_LINE + BUILDER_CLASS_JAVA_DOC + className + PERIOD + NEW_LINE |
| 407 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 408 | } |
| 409 | |
| 410 | /** |
Shankara-Huawei | b9999eb | 2016-07-14 16:53:09 +0530 | [diff] [blame^] | 411 | * Generates javaDocs for the op param class. |
| 412 | * |
| 413 | * @param className class name |
| 414 | * @return javaDocs |
| 415 | */ |
| 416 | private static String generateForOpParamClass(String className) { |
| 417 | return NEW_LINE + JAVA_DOC_FIRST_LINE + OP_PARAM_JAVA_DOC + className + PERIOD + NEW_LINE |
| 418 | + JAVA_DOC_END_LINE; |
| 419 | } |
| 420 | |
| 421 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 422 | * Generates javaDoc for the interface. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 423 | * |
| 424 | * @param interfaceName interface name |
Vinod Kumar S | c421600 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 425 | * @return javaDocs |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 426 | */ |
| 427 | private static String generateForInterface(String interfaceName) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 428 | return NEW_LINE + JAVA_DOC_FIRST_LINE + INTERFACE_JAVA_DOC + interfaceName + PERIOD + NEW_LINE |
| 429 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 430 | } |
| 431 | |
| 432 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 433 | * Generates javaDoc for the builder interface. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 434 | * |
| 435 | * @param builderforName builder for name |
Vinod Kumar S | c421600 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 436 | * @return javaDocs |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 437 | */ |
| 438 | private static String generateForBuilderInterface(String builderforName) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 439 | return JAVA_DOC_FIRST_LINE + BUILDER_INTERFACE_JAVA_DOC + builderforName + PERIOD + NEW_LINE |
| 440 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 441 | } |
| 442 | |
| 443 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 444 | * Generates javaDocs for package-info. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 445 | * |
| 446 | * @param packageName package name |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 447 | * @param isChildNode is it child node |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 448 | * @return javaDocs |
| 449 | */ |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 450 | private static String generateForPackage(String packageName, boolean isChildNode) { |
| 451 | String javaDoc = JAVA_DOC_FIRST_LINE + PACKAGE_INFO_JAVADOC + packageName; |
| 452 | if (isChildNode) { |
| 453 | javaDoc = javaDoc + PACKAGE_INFO_JAVADOC_OF_CHILD; |
| 454 | } |
| 455 | return javaDoc + PERIOD + NEW_LINE + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 456 | } |
| 457 | |
| 458 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 459 | * Generates javaDocs for default constructor. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 460 | * |
Bharat saraswal | 6ef0b76 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 461 | * @param className class name |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 462 | * @return javaDocs |
| 463 | */ |
Bharat saraswal | 6ef0b76 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 464 | private static String generateForDefaultConstructors(String className) { |
| 465 | return FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_CONSTRUCTOR + className |
| 466 | + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 467 | } |
| 468 | |
| 469 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 470 | * Generates javaDocs for constructor with parameters. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 471 | * |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 472 | * @param className class name |
| 473 | * @return javaDocs |
| 474 | */ |
| 475 | private static String generateForConstructors(String className) { |
Bharat saraswal | c0e0484 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 476 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_CONSTRUCTOR |
| 477 | + className + IMPL + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK |
| 478 | + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + BUILDER.toLowerCase() + OBJECT + SPACE + BUILDER_OBJECT |
| 479 | + className + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 480 | } |
| 481 | |
| 482 | /** |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 483 | * Generates javaDocs for build. |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 484 | * |
Vinod Kumar S | c421600 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 485 | * @param buildName builder name |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 486 | * @return javaDocs |
| 487 | */ |
| 488 | private static String generateForBuild(String buildName) { |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 489 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_BUILD |
Bharat saraswal | 2f11f65 | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 490 | + buildName + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION |
Bharat saraswal | e2d51d6 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 491 | + JAVA_DOC_RETURN + JAVA_DOC_BUILD_RETURN + buildName + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION |
| 492 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 493 | } |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 494 | |
| 495 | /** |
| 496 | * Generates javaDocs for type constructor. |
| 497 | * |
| 498 | * @param attribute attribute string |
| 499 | * @return javaDocs for type constructor |
| 500 | */ |
Bharat saraswal | b1170bd | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 501 | public static String generateForTypeConstructor(String attribute) { |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 502 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_CONSTRUCTOR |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 503 | + attribute + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION |
| 504 | + JAVA_DOC_PARAM + VALUE + SPACE + VALUE + SPACE + OF + SPACE + attribute + NEW_LINE |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 505 | + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 506 | } |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 507 | |
| 508 | /** |
| 509 | * Generates javaDocs for add augmentation method. |
| 510 | * |
| 511 | * @return javaDocs |
| 512 | */ |
| 513 | public static String generateForAddAugmentation() { |
| 514 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION |
| 515 | + JAVA_DOC_SETTERS_COMMON + getSmallCase(YANG_AUGMENTED_INFO) + MAP + PERIOD + NEW_LINE + |
| 516 | FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + VALUE + SPACE + |
| 517 | VALUE + SPACE + OF + SPACE + getSmallCase(YANG_AUGMENTED_INFO) + NEW_LINE + FOUR_SPACE_INDENTATION |
| 518 | + JAVA_DOC_PARAM + CLASS + OBJECT_STRING + SPACE + |
| 519 | VALUE + SPACE + OF + SPACE + AUGMENTED + CLASS + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
| 520 | } |
| 521 | |
| 522 | public static String generateForGetAugmentation() { |
| 523 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION |
| 524 | + JAVA_DOC_GETTERS + getSmallCase(YANG_AUGMENTED_INFO) + PERIOD + NEW_LINE + |
| 525 | FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + CLASS + |
| 526 | OBJECT_STRING + SPACE + VALUE + SPACE + OF + SPACE + AUGMENTED + CLASS + NEW_LINE + |
| 527 | FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + VALUE + SPACE + |
| 528 | OF + SPACE + YANG_AUGMENTED_INFO + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
| 529 | } |
| 530 | |
| 531 | /** |
| 532 | * JavaDocs types. |
| 533 | */ |
| 534 | public enum JavaDocType { |
| 535 | |
| 536 | /** |
| 537 | * For class. |
| 538 | */ |
| 539 | IMPL_CLASS, |
| 540 | |
| 541 | /** |
| 542 | * For builder class. |
| 543 | */ |
| 544 | BUILDER_CLASS, |
| 545 | |
| 546 | /** |
| 547 | * For interface. |
| 548 | */ |
| 549 | INTERFACE, |
| 550 | |
| 551 | /** |
| 552 | * For builder interface. |
| 553 | */ |
| 554 | BUILDER_INTERFACE, |
| 555 | |
| 556 | /** |
| 557 | * For package-info. |
| 558 | */ |
| 559 | PACKAGE_INFO, |
| 560 | |
| 561 | /** |
| 562 | * For getters. |
| 563 | */ |
| 564 | GETTER_METHOD, |
| 565 | |
| 566 | /** |
| 567 | * For rpc service. |
| 568 | */ |
| 569 | RPC_INTERFACE, |
| 570 | |
| 571 | /** |
| 572 | * For rpc manager. |
| 573 | */ |
| 574 | RPC_MANAGER, |
| 575 | |
| 576 | /** |
| 577 | * For event. |
| 578 | */ |
| 579 | EVENT, |
| 580 | |
| 581 | /** |
| 582 | * For event listener. |
| 583 | */ |
| 584 | EVENT_LISTENER, |
| 585 | |
| 586 | /** |
| 587 | * For setters. |
| 588 | */ |
| 589 | SETTER_METHOD, |
| 590 | |
| 591 | /** |
| 592 | * For type def's setters. |
| 593 | */ |
| 594 | TYPE_DEF_SETTER_METHOD, |
| 595 | |
| 596 | /** |
| 597 | * For of method. |
| 598 | */ |
| 599 | OF_METHOD, |
| 600 | |
| 601 | /** |
| 602 | * For default constructor. |
| 603 | */ |
| 604 | DEFAULT_CONSTRUCTOR, |
| 605 | |
| 606 | /** |
| 607 | * For constructor. |
| 608 | */ |
| 609 | CONSTRUCTOR, |
| 610 | |
| 611 | /** |
| 612 | * For from method. |
| 613 | */ |
| 614 | FROM_METHOD, |
| 615 | |
| 616 | /** |
| 617 | * For type constructor. |
| 618 | */ |
| 619 | TYPE_CONSTRUCTOR, |
| 620 | |
| 621 | /** |
| 622 | * For build. |
| 623 | */ |
| 624 | BUILD_METHOD, |
| 625 | |
| 626 | /** |
| 627 | * For enum. |
| 628 | */ |
| 629 | ENUM_CLASS, |
| 630 | |
| 631 | /** |
| 632 | * For enum's attributes. |
| 633 | */ |
| 634 | ENUM_ATTRIBUTE, |
| 635 | |
| 636 | /** |
| 637 | * For manager setters. |
| 638 | */ |
| 639 | MANAGER_SETTER_METHOD, |
| 640 | |
| 641 | /** |
| 642 | * For event subject. |
| 643 | */ |
Shankara-Huawei | b9999eb | 2016-07-14 16:53:09 +0530 | [diff] [blame^] | 644 | EVENT_SUBJECT_CLASS, |
| 645 | |
| 646 | /** |
| 647 | * For operation. |
| 648 | */ |
| 649 | OPERATION_CLASS, |
| 650 | |
| 651 | /** |
| 652 | * For operation builder. |
| 653 | */ |
| 654 | OPERATION_BUILDER_CLASS |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 655 | } |
Bharat saraswal | 870c56f | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 656 | } |