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