Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Open Networking Laboratory |
| 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; |
| 18 | |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 19 | import java.io.File; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 20 | import java.util.Arrays; |
| 21 | import java.util.List; |
| 22 | |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 23 | /** |
| 24 | * Provides utility constants while generating java files. |
| 25 | */ |
| 26 | public final class UtilConstants { |
| 27 | |
| 28 | /** |
| 29 | * Default constructor. |
| 30 | */ |
| 31 | private UtilConstants() { |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * For java-docs. |
| 36 | */ |
| 37 | public static final String IMPL_CLASS_JAVA_DOC = " * Provides the implementation of "; |
| 38 | public static final String BUILDER_CLASS_JAVA_DOC = " * Provides the builder implementation of "; |
| 39 | public static final String INTERFACE_JAVA_DOC = " * Abstraction of an entity which provides functionalities of "; |
| 40 | public static final String BUILDER_INTERFACE_JAVA_DOC = " * Builder for "; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 41 | public static final String PACKAGE_INFO_JAVADOC = " * Implementation of YANG file "; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 42 | public static final String JAVA_DOC_FIRST_LINE = "/**\n"; |
| 43 | public static final String JAVA_DOC_END_LINE = " */\n"; |
| 44 | public static final String JAVA_DOC_PARAM = " * @param "; |
| 45 | public static final String JAVA_DOC_RETURN = " * @return "; |
| 46 | public static final String JAVA_DOC_THROWS = " * @throws "; |
| 47 | public static final String JAVA_DOC_SETTERS = " * Returns the builder object of "; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 48 | public static final String JAVA_DOC_OF = " * Returns the object of "; |
| 49 | public static final String JAVA_DOC_SETTERS_COMMON = " * Sets the value of "; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 50 | public static final String JAVA_DOC_GETTERS = " * Returns the attribute "; |
| 51 | public static final String JAVA_DOC_DEFAULT_CONSTRUCTOR = " * Default Constructor.\n"; |
| 52 | public static final String JAVA_DOC_CONSTRUCTOR = " * Construct the object of "; |
| 53 | public static final String JAVA_DOC_BUILD = " * Builds object of "; |
| 54 | public static final String JAVA_DOC_BUILD_RETURN = "object of "; |
| 55 | |
| 56 | /** |
| 57 | * Basic requirements. |
| 58 | */ |
| 59 | public static final String NEW_LINE = "\n"; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 60 | public static final String MULTIPLE_NEW_LINE = "\n\n"; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 61 | public static final String EMPTY_STRING = ""; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 62 | public static final String NEW_LINE_ESTRIC = " *\n"; |
| 63 | public static final String PERIOD = "."; |
| 64 | public static final String COLAN = ":"; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 65 | public static final String UNDER_SCORE = "_"; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 66 | public static final String SEMI_COLAN = ";"; |
| 67 | public static final String HYPHEN = "-"; |
| 68 | public static final String SPACE = " "; |
| 69 | public static final String TAB = "\t"; |
| 70 | public static final String EQUAL = "="; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 71 | public static final String SLASH = File.separator; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 72 | public static final String ADD = "+"; |
| 73 | public static final String ASTERISK = "*"; |
| 74 | public static final String AT = "@"; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 75 | public static final String QUOTES = "\""; |
| 76 | public static final String AND = "&"; |
| 77 | public static final String COMMA = ","; |
| 78 | public static final String ADD_STRING = "add"; |
| 79 | public static final String CHECK_NOT_NULL_STRING = "checkNotNull"; |
| 80 | public static final String HASH_CODE_STRING = "hashCode"; |
| 81 | public static final String EQUALS_STRING = "equals"; |
| 82 | public static final String OBJECT_STRING = "Object"; |
| 83 | public static final String INSTANCE_OF = " instanceof "; |
| 84 | |
| 85 | public static final String VALUE = "value"; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 86 | public static final String SUFIX_S = "s"; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 87 | |
| 88 | public static final String IF = "if"; |
| 89 | public static final String FOR = "for"; |
| 90 | public static final String WHILE = "while"; |
| 91 | public static final String OF = "of"; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 92 | public static final String OTHER = "other"; |
| 93 | public static final String OBJ = "obj"; |
| 94 | public static final String HASH = "hash"; |
| 95 | public static final String TO = "to"; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 96 | |
| 97 | public static final String TRUE = "true"; |
| 98 | public static final String FALSE = "false"; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 99 | public static final String ORG = "org"; |
| 100 | public static final String TEMP = "temp"; |
| 101 | public static final String YANG_RESOURCES = "yang/resources"; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 102 | |
| 103 | /** |
| 104 | * For brackets. |
| 105 | */ |
| 106 | public static final String DIAMOND_OPEN_BRACKET = "<"; |
| 107 | public static final String DIAMOND_CLOSE_BRACKET = ">"; |
| 108 | public static final String SQUARE_OPEN_BRACKET = "["; |
| 109 | public static final String SQUARE_CLOSE_BRACKET = "]"; |
| 110 | public static final String OPEN_PARENTHESIS = "("; |
| 111 | public static final String CLOSE_PARENTHESIS = ")"; |
| 112 | public static final String OPEN_CURLY_BRACKET = "{"; |
| 113 | public static final String CLOSE_CURLY_BRACKET = "}"; |
| 114 | |
| 115 | /** |
| 116 | * For methods. |
| 117 | */ |
| 118 | public static final String GET_METHOD_PREFIX = "get"; |
| 119 | public static final String SET_METHOD_PREFIX = "set"; |
| 120 | |
| 121 | /** |
| 122 | * For indentation. |
| 123 | */ |
| 124 | public static final String FOUR_SPACE_INDENTATION = " "; |
| 125 | public static final String EIGHT_SPACE_INDENTATION = FOUR_SPACE_INDENTATION + FOUR_SPACE_INDENTATION; |
| 126 | public static final String TWELVE_SPACE_INDENTATION = FOUR_SPACE_INDENTATION + EIGHT_SPACE_INDENTATION; |
| 127 | public static final String SIXTEEN_SPACE_INDENTATION = EIGHT_SPACE_INDENTATION + EIGHT_SPACE_INDENTATION; |
| 128 | |
| 129 | /** |
| 130 | * For directories. |
| 131 | */ |
Bharat saraswal | 5600f0f | 2016-03-09 18:34:56 +0530 | [diff] [blame] | 132 | public static final String YANG_GEN_DIR = "src/main/java/"; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 133 | public static final String DEFAULT_BASE_PKG = "org.onosproject.yang.gen"; |
| 134 | public static final String REVISION_PREFIX = "rev"; |
| 135 | public static final String VERSION_PREFIX = "v"; |
| 136 | |
| 137 | /** |
| 138 | * For class modifiers. |
| 139 | */ |
| 140 | public static final String PRIVATE = "private"; |
| 141 | public static final String PUBLIC = "public"; |
| 142 | public static final String PROTECTED = "protected"; |
| 143 | |
| 144 | /** |
| 145 | * For data types. |
| 146 | */ |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 147 | /** |
| 148 | * Void java type. |
| 149 | */ |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 150 | public static final String VOID = "void"; |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 151 | |
| 152 | /** |
| 153 | * String built in java type. |
| 154 | */ |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 155 | public static final String STRING = "String"; |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 156 | /** |
| 157 | * java.lang.* packages. |
| 158 | */ |
| 159 | public static final String JAVA_LANG = "java.lang"; |
| 160 | |
| 161 | /** |
| 162 | * boolean built in java type. |
| 163 | */ |
| 164 | public static final String BOOLEAN = "boolean"; |
| 165 | |
| 166 | /** |
| 167 | * byte java built in type. |
| 168 | */ |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 169 | public static final String BYTE = "byte"; |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 170 | |
| 171 | /** |
| 172 | * short java built in type. |
| 173 | */ |
| 174 | public static final String SHORT = "short"; |
| 175 | |
| 176 | /** |
| 177 | * int java built in type. |
| 178 | */ |
| 179 | public static final String INT = "int"; |
| 180 | |
| 181 | /** |
| 182 | * long java built in type. |
| 183 | */ |
| 184 | public static final String LONG = "long"; |
| 185 | |
| 186 | /** |
| 187 | * float java built in type. |
| 188 | */ |
| 189 | public static final String FLOAT = "float"; |
| 190 | |
| 191 | /** |
| 192 | * double java built in type. |
| 193 | */ |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 194 | public static final String DOUBLE = "double"; |
| 195 | |
| 196 | /** |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 197 | * boolean built in java wrapper type. |
| 198 | */ |
| 199 | public static final String BOOLEAN_WRAPPER = "Boolean"; |
| 200 | |
| 201 | /** |
| 202 | * byte java built in wrapper type. |
| 203 | */ |
| 204 | public static final String BYTE_WRAPPER = "Byte"; |
| 205 | |
| 206 | /** |
| 207 | * short java built in wrapper type. |
| 208 | */ |
| 209 | public static final String SHORT_WRAPPER = "Short"; |
| 210 | |
| 211 | /** |
| 212 | * Integer java built in wrapper type. |
| 213 | */ |
| 214 | public static final String INTEGER_WRAPPER = "Integer"; |
| 215 | |
| 216 | /** |
| 217 | * long java built in wrapper type. |
| 218 | */ |
| 219 | public static final String LONG_WRAPPER = "Long"; |
| 220 | |
| 221 | /** |
| 222 | * float java built in wrapper type. |
| 223 | */ |
| 224 | public static final String FLOAT_WRAPPER = "Float"; |
| 225 | |
| 226 | /** |
| 227 | * double java built in wrapper type. |
| 228 | */ |
| 229 | public static final String DOUBLE_WRAPPER = "Double"; |
| 230 | |
| 231 | /** |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 232 | * List of keywords in java, this is used for checking if the input does not |
| 233 | * contain these keywords. |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 234 | */ |
| 235 | public static final List JAVA_KEY_WORDS = Arrays.asList("abstract", "assert", "boolean", "break", "byte", "case", |
| 236 | "catch", "char", "class", "const", "continue", "default", "do", "double", "else", "extends", "false", |
| 237 | "final", "finally", "float", "for", "goto", "if", "implements", "import", "instanceof", "int", "interface", |
| 238 | "long", "native", "new", "null", "package", "private", "protected", "public", "return", "short", "static", |
| 239 | "strictfp", "super", "switch", "synchronized", "this", "throw", "throws", "transient", "true", "try", |
| 240 | "void", "volatile", "while"); |
| 241 | |
| 242 | /** |
| 243 | * Defining regular expression. |
| 244 | */ |
| 245 | public static final String REGEX_WITH_SPECIAL_CHAR = "[ : / - @ $ # ' * + , ; = ]+"; |
| 246 | public static final String REGEX_FOR_FIRST_DIGIT = "\\d.*"; |
| 247 | |
| 248 | /** |
| 249 | * For identifiers. |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 250 | */ |
| 251 | public static final String CLASS = "class"; |
| 252 | public static final String BUILDER = "Builder"; |
| 253 | public static final String BUILDER_OBJECT = "builder object of "; |
| 254 | public static final String INTERFACE = "interface"; |
| 255 | public static final String ENUM = "enum"; |
| 256 | public static final String STATIC = "static"; |
| 257 | public static final String FINAL = "final"; |
| 258 | public static final String PACKAGE = "package"; |
Bharat saraswal | 5e3c45c | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 259 | public static final String IMPORT = "import "; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 260 | public static final String NULL = "null"; |
| 261 | public static final String RETURN = "return"; |
| 262 | public static final String NEW = "new"; |
| 263 | public static final String THIS = "this"; |
| 264 | public static final String IMPLEMENTS = "implements"; |
| 265 | public static final String EXTEND = "extends"; |
| 266 | public static final String IMPL = "Impl"; |
| 267 | public static final String BUILD = "build"; |
| 268 | public static final String OBJECT = "Object"; |
| 269 | public static final String OVERRIDE = "@Override"; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 270 | public static final String CHILDREN = "'s children"; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 271 | |
| 272 | /** |
| 273 | * For collections. |
| 274 | */ |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 275 | public static final String COLLECTION_IMPORTS = "java.util"; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 276 | public static final String GOOGLE_MORE_OBJECT_IMPORT_PKG = "com.google.common.base"; |
| 277 | public static final String GOOGLE_MORE_OBJECT_IMPORT_CLASS = "MoreObjects;\n"; |
| 278 | public static final String GOOGLE_MORE_OBJECT_METHOD_STRING = " MoreObjects.toStringHelper(getClass())"; |
| 279 | public static final String JAVA_UTIL_OBJECTS_IMPORT_PKG = "java.util"; |
| 280 | public static final String JAVA_UTIL_OBJECTS_IMPORT_CLASS = "Objects;\n"; |
Bharat saraswal | dedf9f8 | 2016-02-12 20:48:30 +0530 | [diff] [blame] | 281 | public static final String ABSTRACT_COLLECTION = "AbstractCollection"; |
| 282 | |
| 283 | public static final String LIST = "List"; |
| 284 | public static final String LINKED_LIST = "LinkedList"; |
| 285 | public static final String ARRAY_LIST = "ArrayList"; |
| 286 | public static final String ABSTRACT_LIST = "AbstractList"; |
| 287 | public static final String ABSTRACT_SEQUENTAIL_LIST = "AbstractSequentialList"; |
| 288 | |
| 289 | public static final String SET = "Set"; |
| 290 | public static final String HASH_SET = "HashSet"; |
| 291 | public static final String ABSTRACT_SET = "AbstractSet"; |
| 292 | public static final String LINKED_HASH_SET = "LinkedHashSet"; |
| 293 | public static final String TREE_SET = "TreeSet"; |
| 294 | |
| 295 | public static final String MAP = "Map"; |
| 296 | public static final String ABSTRACT_MAP = "AbstractMap"; |
| 297 | public static final String HASH_MAP = "HashMap"; |
| 298 | public static final String TREE_MAP = "TreeMap"; |
| 299 | public static final String CONCURRENT_MAP = "ConcurrentMap"; |
| 300 | public static final String EVENTUALLY_CONSISTENT_MAP = "EventuallyConsitentMap"; |
| 301 | public static final String STACK = "stack"; |
| 302 | } |