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