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