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 | |
| 19 | import org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 20 | |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 21 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER; |
| 22 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER_CLASS_JAVA_DOC; |
| 23 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER_INTERFACE_JAVA_DOC; |
| 24 | import static org.onosproject.yangutils.utils.UtilConstants.BUILDER_OBJECT; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 25 | import static org.onosproject.yangutils.utils.UtilConstants.ENUM_ATTRIBUTE_JAVADOC; |
| 26 | import static org.onosproject.yangutils.utils.UtilConstants.ENUM_CLASS_JAVADOC; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 27 | import static org.onosproject.yangutils.utils.UtilConstants.FOUR_SPACE_INDENTATION; |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 28 | import static org.onosproject.yangutils.utils.UtilConstants.FROM_STRING_METHOD_NAME; |
| 29 | import static org.onosproject.yangutils.utils.UtilConstants.FROM_STRING_PARAM_NAME; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 30 | import static org.onosproject.yangutils.utils.UtilConstants.IMPL; |
| 31 | import static org.onosproject.yangutils.utils.UtilConstants.IMPL_CLASS_JAVA_DOC; |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 32 | import static org.onosproject.yangutils.utils.UtilConstants.INPUT; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.utils.UtilConstants.INTERFACE_JAVA_DOC; |
| 34 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_BUILD; |
| 35 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_BUILD_RETURN; |
| 36 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_CONSTRUCTOR; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_END_LINE; |
| 38 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_FIRST_LINE; |
| 39 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_GETTERS; |
| 40 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_OF; |
| 41 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_PARAM; |
| 42 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_RETURN; |
| 43 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_SETTERS; |
| 44 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_DOC_SETTERS_COMMON; |
| 45 | import static org.onosproject.yangutils.utils.UtilConstants.LIST; |
| 46 | import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE; |
Bharat saraswal | d532a4c | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 47 | import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE_ASTERISK; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 48 | import static org.onosproject.yangutils.utils.UtilConstants.OBJECT; |
| 49 | import static org.onosproject.yangutils.utils.UtilConstants.OF; |
| 50 | import static org.onosproject.yangutils.utils.UtilConstants.PACKAGE_INFO_JAVADOC; |
| 51 | import static org.onosproject.yangutils.utils.UtilConstants.PERIOD; |
| 52 | import static org.onosproject.yangutils.utils.UtilConstants.SPACE; |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 53 | import static org.onosproject.yangutils.utils.UtilConstants.STRING_DATA_TYPE; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 54 | import static org.onosproject.yangutils.utils.UtilConstants.VALUE; |
| 55 | |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 56 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 57 | * Represents javadoc for the generated classes. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 58 | */ |
| 59 | public final class JavaDocGen { |
| 60 | |
| 61 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 62 | * Creates an instance of java doc gen. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 63 | */ |
| 64 | private JavaDocGen() { |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * JavaDocs types. |
| 69 | */ |
Vidyashree Rama | 02f115f | 2016-04-18 12:29:39 +0530 | [diff] [blame] | 70 | public enum JavaDocType { |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 71 | |
| 72 | /** |
| 73 | * For class. |
| 74 | */ |
| 75 | IMPL_CLASS, |
| 76 | |
| 77 | /** |
| 78 | * For builder class. |
| 79 | */ |
| 80 | BUILDER_CLASS, |
| 81 | |
| 82 | /** |
| 83 | * For interface. |
| 84 | */ |
| 85 | INTERFACE, |
| 86 | |
| 87 | /** |
| 88 | * For builder interface. |
| 89 | */ |
| 90 | BUILDER_INTERFACE, |
| 91 | |
| 92 | /** |
| 93 | * For package-info. |
| 94 | */ |
| 95 | PACKAGE_INFO, |
| 96 | |
| 97 | /** |
| 98 | * For getters. |
| 99 | */ |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 100 | GETTER_METHOD, |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 101 | |
| 102 | /** |
| 103 | * For setters. |
| 104 | */ |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 105 | SETTER_METHOD, |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 106 | |
| 107 | /** |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 108 | * For type def's setters. |
| 109 | */ |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 110 | TYPE_DEF_SETTER_METHOD, |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 111 | |
| 112 | /** |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 113 | * For of method. |
| 114 | */ |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 115 | OF_METHOD, |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 116 | |
| 117 | /** |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 118 | * For default constructor. |
| 119 | */ |
| 120 | DEFAULT_CONSTRUCTOR, |
| 121 | |
| 122 | /** |
| 123 | * For constructor. |
| 124 | */ |
| 125 | CONSTRUCTOR, |
| 126 | |
| 127 | /** |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 128 | * For union's from method. |
| 129 | */ |
| 130 | UNION_FROM_METHOD, |
| 131 | |
| 132 | /** |
| 133 | * For type constructor. |
| 134 | */ |
| 135 | TYPE_CONSTRUCTOR, |
| 136 | |
| 137 | /** |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 138 | * For build. |
| 139 | */ |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 140 | BUILD_METHOD, |
| 141 | |
| 142 | /** |
| 143 | * For enum. |
| 144 | */ |
| 145 | ENUM_CLASS, |
| 146 | |
| 147 | /** |
| 148 | * For enum's attributes. |
| 149 | */ |
| 150 | ENUM_ATTRIBUTE |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | /** |
| 154 | * Returns java docs. |
| 155 | * |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 156 | * @param type java doc type |
| 157 | * @param name name of the YangNode |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 158 | * @param isList is list attribute |
| 159 | * @return javadocs. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 160 | */ |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 161 | public static String getJavaDoc(JavaDocType type, String name, boolean isList) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 162 | |
janani b | 1c6acc4 | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 163 | name = JavaIdentifierSyntax.getSmallCase(JavaIdentifierSyntax.getCamelCase(name, null)); |
Vidyashree Rama | 02f115f | 2016-04-18 12:29:39 +0530 | [diff] [blame] | 164 | String javaDoc; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 165 | if (type.equals(JavaDocType.IMPL_CLASS)) { |
| 166 | javaDoc = generateForImplClass(name); |
| 167 | } else if (type.equals(JavaDocType.BUILDER_CLASS)) { |
| 168 | javaDoc = generateForBuilderClass(name); |
| 169 | } else if (type.equals(JavaDocType.INTERFACE)) { |
| 170 | javaDoc = generateForInterface(name); |
| 171 | } else if (type.equals(JavaDocType.BUILDER_INTERFACE)) { |
| 172 | javaDoc = generateForBuilderInterface(name); |
| 173 | } else if (type.equals(JavaDocType.PACKAGE_INFO)) { |
| 174 | javaDoc = generateForPackage(name); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 175 | } else if (type.equals(JavaDocType.GETTER_METHOD)) { |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 176 | javaDoc = generateForGetters(name, isList); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 177 | } else if (type.equals(JavaDocType.TYPE_DEF_SETTER_METHOD)) { |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 178 | javaDoc = generateForTypeDefSetter(name); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 179 | } else if (type.equals(JavaDocType.SETTER_METHOD)) { |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 180 | javaDoc = generateForSetters(name, isList); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 181 | } else if (type.equals(JavaDocType.OF_METHOD)) { |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 182 | javaDoc = generateForOf(name); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 183 | } else if (type.equals(JavaDocType.DEFAULT_CONSTRUCTOR)) { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 184 | javaDoc = generateForDefaultConstructors(name); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 185 | } else if (type.equals(JavaDocType.BUILD_METHOD)) { |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 186 | javaDoc = generateForBuild(name); |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 187 | } else if (type.equals(JavaDocType.TYPE_CONSTRUCTOR)) { |
| 188 | javaDoc = generateForTypeConstructor(name); |
| 189 | } else if (type.equals(JavaDocType.UNION_FROM_METHOD)) { |
| 190 | javaDoc = generateForUnionFrom(name); |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 191 | } else if (type.equals(JavaDocType.ENUM_CLASS)) { |
| 192 | javaDoc = generateForEnum(name); |
| 193 | } else if (type.equals(JavaDocType.ENUM_ATTRIBUTE)) { |
| 194 | javaDoc = generateForEnumAttr(name); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 195 | } else { |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 196 | javaDoc = generateForConstructors(name); |
| 197 | } |
| 198 | return javaDoc; |
| 199 | } |
| 200 | |
| 201 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 202 | * Generates javaDocs for enum's attributes. |
| 203 | * |
| 204 | * @param name attribute name |
| 205 | * @return javaDocs |
| 206 | */ |
| 207 | private static String generateForEnumAttr(String name) { |
| 208 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + ENUM_ATTRIBUTE_JAVADOC |
| 209 | + name + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * Generates javaDocs for getter method. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 214 | * |
| 215 | * @param attribute attribute |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 216 | * @param isList is list attribute |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 217 | * @return javaDocs |
| 218 | */ |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 219 | private static String generateForGetters(String attribute, boolean isList) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 220 | |
| 221 | 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] | 222 | + 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] | 223 | + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 224 | if (isList) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 225 | String listAttribute = LIST.toLowerCase() + SPACE + OF + SPACE; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 226 | getter = getter + listAttribute; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 227 | } else { |
| 228 | getter = getter + VALUE + SPACE + OF + SPACE; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 229 | } |
| 230 | |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 231 | getter = getter + attribute + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 232 | return getter; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 233 | } |
| 234 | |
| 235 | /** |
| 236 | * Generates javaDocs for setter method. |
| 237 | * |
| 238 | * @param attribute attribute |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 239 | * @param isList is list attribute |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 240 | * @return javaDocs |
| 241 | */ |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 242 | private static String generateForSetters(String attribute, boolean isList) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 243 | |
| 244 | 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] | 245 | + 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] | 246 | + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + attribute + SPACE; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 247 | if (isList) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 248 | String listAttribute = LIST.toLowerCase() + SPACE + OF + SPACE; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 249 | setter = setter + listAttribute; |
| 250 | } else { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 251 | setter = setter + VALUE + SPACE + OF + SPACE; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 252 | } |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 253 | setter = setter + attribute + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + BUILDER_OBJECT + attribute |
| 254 | + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 255 | return setter; |
| 256 | } |
| 257 | |
| 258 | /** |
| 259 | * Generates javaDocs for of method. |
| 260 | * |
| 261 | * @param attribute attribute |
| 262 | * @return javaDocs |
| 263 | */ |
| 264 | private static String generateForOf(String attribute) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 265 | 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] | 266 | + 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] | 267 | + JAVA_DOC_PARAM + VALUE + SPACE + VALUE + SPACE + OF + SPACE + attribute + NEW_LINE |
| 268 | + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + OBJECT + SPACE + OF + SPACE + attribute + NEW_LINE |
| 269 | + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 270 | } |
| 271 | |
| 272 | /** |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 273 | * Generates javaDocs for from method. |
| 274 | * |
| 275 | * @param attribute attribute |
| 276 | * @return javaDocs |
| 277 | */ |
| 278 | private static String generateForUnionFrom(String attribute) { |
| 279 | |
| 280 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_OF |
| 281 | + attribute + SPACE + FROM_STRING_METHOD_NAME + SPACE + INPUT + SPACE + STRING_DATA_TYPE + PERIOD |
| 282 | + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM |
| 283 | + FROM_STRING_PARAM_NAME + SPACE + INPUT + SPACE + STRING_DATA_TYPE + PERIOD + NEW_LINE |
| 284 | + FOUR_SPACE_INDENTATION + JAVA_DOC_RETURN + OBJECT + SPACE + OF + SPACE + attribute + NEW_LINE |
| 285 | + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
| 286 | } |
| 287 | |
| 288 | /** |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 289 | * Generates javaDocs for typedef setter method. |
| 290 | * |
| 291 | * @param attribute attribute |
| 292 | * @return javaDocs |
| 293 | */ |
| 294 | private static String generateForTypeDefSetter(String attribute) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 295 | 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] | 296 | + 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] | 297 | + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM + VALUE + SPACE + VALUE + SPACE + OF + SPACE + attribute |
| 298 | + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 299 | } |
| 300 | |
| 301 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 302 | * Generates javaDocs for the impl class. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 303 | * |
| 304 | * @param className class name |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 305 | * @return javaDocs |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 306 | */ |
| 307 | private static String generateForImplClass(String className) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 308 | 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] | 309 | } |
| 310 | |
| 311 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 312 | * Generates javaDocs for enum. |
| 313 | * |
| 314 | * @param className enum class name |
| 315 | * @return javaDocs |
| 316 | */ |
| 317 | private static String generateForEnum(String className) { |
| 318 | return NEW_LINE + NEW_LINE + JAVA_DOC_FIRST_LINE + ENUM_CLASS_JAVADOC + className + PERIOD + NEW_LINE |
| 319 | + JAVA_DOC_END_LINE; |
| 320 | } |
| 321 | |
| 322 | /** |
| 323 | * Generates javaDocs for the builder class. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 324 | * |
| 325 | * @param className class name |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 326 | * @return javaDocs |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 327 | */ |
| 328 | private static String generateForBuilderClass(String className) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 329 | return NEW_LINE + JAVA_DOC_FIRST_LINE + BUILDER_CLASS_JAVA_DOC + className + PERIOD + NEW_LINE |
| 330 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 331 | } |
| 332 | |
| 333 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 334 | * Generates javaDoc for the interface. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 335 | * |
| 336 | * @param interfaceName interface name |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 337 | * @return javaDocs |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 338 | */ |
| 339 | private static String generateForInterface(String interfaceName) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 340 | return NEW_LINE + JAVA_DOC_FIRST_LINE + INTERFACE_JAVA_DOC + interfaceName + PERIOD + NEW_LINE |
| 341 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 342 | } |
| 343 | |
| 344 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 345 | * Generates javaDoc for the builder interface. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 346 | * |
| 347 | * @param builderforName builder for name |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 348 | * @return javaDocs |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 349 | */ |
| 350 | private static String generateForBuilderInterface(String builderforName) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 351 | return JAVA_DOC_FIRST_LINE + BUILDER_INTERFACE_JAVA_DOC + builderforName + PERIOD + NEW_LINE |
| 352 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 353 | } |
| 354 | |
| 355 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 356 | * Generates javaDocs for package-info. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 357 | * |
| 358 | * @param packageName package name |
| 359 | * @return javaDocs |
| 360 | */ |
| 361 | private static String generateForPackage(String packageName) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 362 | return JAVA_DOC_FIRST_LINE + PACKAGE_INFO_JAVADOC + packageName + PERIOD + NEW_LINE + JAVA_DOC_END_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 363 | } |
| 364 | |
| 365 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 366 | * Generates javaDocs for default constructor. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 367 | * |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 368 | * @param className class name |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 369 | * @return javaDocs |
| 370 | */ |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 371 | private static String generateForDefaultConstructors(String className) { |
| 372 | return FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_CONSTRUCTOR + className |
| 373 | + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 374 | } |
| 375 | |
| 376 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 377 | * Generates javaDocs for constructor with parameters. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 378 | * |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 379 | * @param className class name |
| 380 | * @return javaDocs |
| 381 | */ |
| 382 | private static String generateForConstructors(String className) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 383 | return NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE |
| 384 | + FOUR_SPACE_INDENTATION + JAVA_DOC_CONSTRUCTOR + className + IMPL + PERIOD + NEW_LINE |
Bharat saraswal | d532a4c | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 385 | + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION + JAVA_DOC_PARAM |
| 386 | + BUILDER.toLowerCase() + OBJECT + SPACE + BUILDER_OBJECT + className + NEW_LINE |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 387 | + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 388 | } |
| 389 | |
| 390 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 391 | * Generates javaDocs for build. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 392 | * |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 393 | * @param buildName builder name |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 394 | * @return javaDocs |
| 395 | */ |
| 396 | private static String generateForBuild(String buildName) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 397 | 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] | 398 | + 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] | 399 | + JAVA_DOC_RETURN + JAVA_DOC_BUILD_RETURN + buildName + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION |
| 400 | + JAVA_DOC_END_LINE; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 401 | } |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 402 | |
| 403 | /** |
| 404 | * Generates javaDocs for type constructor. |
| 405 | * |
| 406 | * @param attribute attribute string |
| 407 | * @return javaDocs for type constructor |
| 408 | */ |
| 409 | private static String generateForTypeConstructor(String attribute) { |
| 410 | |
| 411 | return (NEW_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_FIRST_LINE + FOUR_SPACE_INDENTATION + JAVA_DOC_CONSTRUCTOR |
| 412 | + attribute + PERIOD + NEW_LINE + FOUR_SPACE_INDENTATION + NEW_LINE_ASTERISK + FOUR_SPACE_INDENTATION |
| 413 | + JAVA_DOC_PARAM + VALUE + SPACE + VALUE + SPACE + OF + SPACE + attribute + NEW_LINE |
| 414 | + FOUR_SPACE_INDENTATION + JAVA_DOC_END_LINE); |
| 415 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 416 | } |