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