blob: e83c0750c1e3f201a1fc8ca6daf0ec763ce624b5 [file] [log] [blame]
Bharat saraswal708abc02016-02-12 20:48:30 +05301/*
Brian O'Connor5ab426f2016-04-09 01:19:45 -07002 * Copyright 2016-present Open Networking Laboratory
Bharat saraswal708abc02016-02-12 20:48:30 +05303 *
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
17package org.onosproject.yangutils.utils;
18
Vinod Kumar S38046502016-03-23 15:30:27 +053019import java.io.File;
b.janani1fef2732016-03-04 12:29:05 +053020import java.util.Arrays;
21import java.util.List;
22
Bharat saraswal708abc02016-02-12 20:48:30 +053023/**
Bharat saraswald9822e92016-04-05 15:13:44 +053024 * Represents utilities constants which are used while generating java files.
Bharat saraswal708abc02016-02-12 20:48:30 +053025 */
26public final class UtilConstants {
27
28 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +053029 * JavaDocs for impl class.
Bharat saraswal708abc02016-02-12 20:48:30 +053030 */
Gaurav Agrawal338735b2016-04-18 18:53:11 +053031 public static final String IMPL_CLASS_JAVA_DOC = " * Represents the implementation of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +053032
33 /**
34 * JavaDocs for builder class.
35 */
Gaurav Agrawal338735b2016-04-18 18:53:11 +053036 public static final String BUILDER_CLASS_JAVA_DOC = " * Represents the builder implementation of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +053037
38 /**
39 * JavaDocs for interface class.
40 */
Gaurav Agrawal338735b2016-04-18 18:53:11 +053041 public static final String INTERFACE_JAVA_DOC = " * Abstraction of an entity which represents the"
42 + " functionality of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +053043
VinodKumarS-Huaweicb3a1f52016-05-10 17:58:57 +053044 /**
45 * JavaDocs for event.
46 */
47 public static final String EVENT_JAVA_DOC = " * Represents event implementation of ";
48
49 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +053050 * JavaDocs for op param class.
51 */
52 public static final String OP_PARAM_JAVA_DOC = " * Represents operation parameter implementation of ";
53
54 /**
VinodKumarS-Huaweicb3a1f52016-05-10 17:58:57 +053055 * JavaDocs for event listener.
56 */
57 public static final String EVENT_LISTENER_JAVA_DOC = " * Abstraction for event listener of ";
58
Bharat saraswal2f11f652016-03-25 18:19:46 +053059 /**
60 * JavaDocs for builder interface class.
61 */
Bharat saraswal708abc02016-02-12 20:48:30 +053062 public static final String BUILDER_INTERFACE_JAVA_DOC = " * Builder for ";
Bharat saraswal2f11f652016-03-25 18:19:46 +053063
64 /**
Bharat saraswald72411a2016-04-19 01:00:16 +053065 * JavaDocs for enum class.
66 */
67 public static final String ENUM_CLASS_JAVADOC = " * Represents ENUM data of ";
68
69 /**
70 * JavaDocs for enum attribute.
71 */
72 public static final String ENUM_ATTRIBUTE_JAVADOC = " * Represents ";
73
74 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +053075 * JavaDocs for package info class.
76 */
Bharat saraswald72411a2016-04-19 01:00:16 +053077 public static final String PACKAGE_INFO_JAVADOC = " * Implementation of YANG node ";
78
79 /**
80 * JavaDocs for package info class.
81 */
82 public static final String PACKAGE_INFO_JAVADOC_OF_CHILD = "'s children nodes";
Bharat saraswal2f11f652016-03-25 18:19:46 +053083
84 /**
85 * JavaDocs's first line.
86 */
Bharat saraswal708abc02016-02-12 20:48:30 +053087 public static final String JAVA_DOC_FIRST_LINE = "/**\n";
Bharat saraswal2f11f652016-03-25 18:19:46 +053088
89 /**
90 * JavaDocs's last line.
91 */
Bharat saraswal708abc02016-02-12 20:48:30 +053092 public static final String JAVA_DOC_END_LINE = " */\n";
Bharat saraswal2f11f652016-03-25 18:19:46 +053093
94 /**
95 * JavaDocs's param annotation.
96 */
Bharat saraswal708abc02016-02-12 20:48:30 +053097 public static final String JAVA_DOC_PARAM = " * @param ";
Bharat saraswal2f11f652016-03-25 18:19:46 +053098
99 /**
100 * JavaDocs's return annotation.
101 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530102 public static final String JAVA_DOC_RETURN = " * @return ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530103
104 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530105 * JavaDocs's description for setter method.
106 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530107 public static final String JAVA_DOC_SETTERS = " * Returns the builder object of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530108
109 /**
VinodKumarS-Huaweicb3a1f52016-05-10 17:58:57 +0530110 * JavaDocs's description for setter method.
111 */
112 public static final String JAVA_DOC_MANAGER_SETTERS = " * Sets the value to attribute ";
113
114 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530115 * JavaDocs's description for OF method.
116 */
b.janani1fef2732016-03-04 12:29:05 +0530117 public static final String JAVA_DOC_OF = " * Returns the object of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530118
119 /**
120 * JavaDocs's description for typedef' setter method.
121 */
b.janani1fef2732016-03-04 12:29:05 +0530122 public static final String JAVA_DOC_SETTERS_COMMON = " * Sets the value of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530123
124 /**
125 * JavaDocs's description for getter method.
126 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530127 public static final String JAVA_DOC_GETTERS = " * Returns the attribute ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530128
129 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530130 * JavaDocs's description for constructor.
131 */
Bharat saraswal6ef0b762016-04-05 12:45:45 +0530132 public static final String JAVA_DOC_CONSTRUCTOR = " * Creates an instance of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530133
134 /**
135 * JavaDocs's description for build method.
136 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530137 public static final String JAVA_DOC_BUILD = " * Builds object of ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530138
139 /**
140 * JavaDocs's return statement for build method.
141 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530142 public static final String JAVA_DOC_BUILD_RETURN = "object of ";
143
144 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530145 * JavaDocs's statement for builder object.
146 */
147 public static final String BUILDER_OBJECT = "builder object of ";
148
149 /**
Gaurav Agrawal56527662016-04-20 15:49:17 +0530150 * JavaDocs's statement for rpc method.
151 */
152 public static final String JAVA_DOC_RPC = " * Service interface of ";
153
154 /**
155 * JavaDocs's statement for rpc's input string.
156 */
157 public static final String RPC_INPUT_STRING = "input of service interface ";
158
159 /**
160 * JavaDocs's statement for rpc's output string.
161 */
162 public static final String RPC_OUTPUT_STRING = "output of service interface ";
163
164 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530165 * Static attribute for new line.
Bharat saraswal708abc02016-02-12 20:48:30 +0530166 */
167 public static final String NEW_LINE = "\n";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530168
169 /**
Bharat saraswalc0e04842016-05-12 13:16:57 +0530170 * Static attribute for default.
171 */
172 public static final String DEFAULT = "default";
173
174 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +0530175 * Static attribute for op param class.
176 */
177 public static final String OPERATION = "OpParam";
178
179 /**
180 * Static attribute for operation type.
181 */
182 public static final String OPERATION_ENUM = "OperationType";
183
184 /**
185 * Static attribute for java code generation for sbi.
186 */
187 public static final String SBI = "sbi";
188
189 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530190 * Static attribute for multiple new line.
191 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530192 public static final String MULTIPLE_NEW_LINE = "\n\n";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530193
194 /**
195 * Static attribute for empty line.
196 */
b.janani1fef2732016-03-04 12:29:05 +0530197 public static final String EMPTY_STRING = "";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530198
199 /**
200 * Static attribute for new line with asterisk.
201 */
202 public static final String NEW_LINE_ASTERISK = " *\n";
203
204 /**
205 * Static attribute for period.
206 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530207 public static final String PERIOD = ".";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530208
209 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530210 * Static attribute for parse byte.
211 */
212 public static final String PARSE_BYTE = "parseByte";
213
214 /**
Mahesh Poojary Huawei46fb4db2016-07-14 12:38:17 +0530215 * Static attribute for get bytes.
216 */
217 public static final String GET_BYTES = "getBytes";
218
219 /**
Bharat saraswal33dfa012016-05-17 19:59:16 +0530220 * Static attribute for parse boolean.
221 */
222 public static final String PARSE_BOOLEAN = "parseBoolean";
223
224 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530225 * Static attribute for parse short.
226 */
227 public static final String PARSE_SHORT = "parseShort";
228
229 /**
230 * Static attribute for parse int.
231 */
232 public static final String PARSE_INT = "parseInt";
233
234 /**
235 * Static attribute for parse long.
236 */
237 public static final String PARSE_LONG = "parseLong";
238
239 /**
Mahesh Poojary Huawei30c116a2016-07-14 17:49:50 +0530240 * Static attribute for base64.
241 */
242 public static final String BASE64 = "Base64";
243
244 /**
245 * Static attribute for getEncoder.
246 */
247 public static final String GET_ENCODER = "getEncoder";
248
249 /**
250 * Static attribute for encodeToString.
251 */
252 public static final String ENCODE_TO_STRING = "encodeToString";
253
254 /**
255 * Static attribute for getDecoder.
256 */
257 public static final String GET_DECODER = "getDecoder";
258
259 /**
260 * Static attribute for decode.
261 */
262 public static final String DECODE = "decode";
263
264 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530265 * Static attribute for omit null value.
266 */
267 public static final String OMIT_NULL_VALUE_STRING = "omitNullValues()";
268
269 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530270 * Static attribute for colan.
271 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530272 public static final String COLAN = ":";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530273
274 /**
275 * Static attribute for underscore.
276 */
b.janani1fef2732016-03-04 12:29:05 +0530277 public static final String UNDER_SCORE = "_";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530278
279 /**
280 * Static attribute for semi-colan.
281 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530282 public static final String SEMI_COLAN = ";";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530283
284 /**
285 * Static attribute for hyphen.
286 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530287 public static final String HYPHEN = "-";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530288
289 /**
290 * Static attribute for space.
291 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530292 public static final String SPACE = " ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530293
294 /**
Bharat saraswal33dfa012016-05-17 19:59:16 +0530295 * Static attribute for subject.
296 */
297 public static final String SUBJECT = "Subject";
298
299 /**
Bharat saraswalab4c6ba2016-05-17 14:19:38 +0530300 * Static attribute for ListenerRegistry.
301 */
302 public static final String LISTENER_REG = "ListenerRegistry";
303
304 /**
305 * Static attribute for ListenerService.
306 */
307 public static final String LISTENER_SERVICE = "ListenerService";
308
309 /**
310 * Static attribute for listener package.
311 */
Bharat saraswal33dfa012016-05-17 19:59:16 +0530312 public static final String ONOS_EVENT_PKG = "org.onosproject.event";
Bharat saraswalab4c6ba2016-05-17 14:19:38 +0530313
314 /**
Vidyashree Rama1db15562016-05-17 16:16:15 +0530315 * Static attribute for colon.
316 */
317 public static final String COLON = ":";
318
319 /**
320 * Static attribute for caret.
321 */
322 public static final String CARET = "^";
323
324 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530325 * Static attribute for input string.
Bharat saraswal2f11f652016-03-25 18:19:46 +0530326 */
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530327 public static final String INPUT = "input";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530328
329 /**
janani be18b5342016-07-13 21:06:41 +0530330 * Static attribute for output string.
331 */
332 public static final String OUTPUT = "output";
333
334 /**
335 * Static attribute for current string.
336 */
337 public static final String CURRENT = "current";
338
339 /**
janani b6240d292016-05-17 18:20:33 +0530340 * Static attribute for leafref string.
341 */
342 public static final String LEAFREF = "leafref";
343
344 /**
345 * Static attribute for identityref string.
346 */
347 public static final String IDENTITYREF = "identityref";
348
349 /**
Mahesh Poojary Huawei30c116a2016-07-14 17:49:50 +0530350 * Static attribute for binary string.
351 */
352 public static final String BINARY_STRING = "binary";
353
354 /**
355 * Static attribute for bits string.
356 */
357 public static final String BITS_STRING = "bits";
358
359 /**
Gaurav Agrawal56527662016-04-20 15:49:17 +0530360 * Static attribute for output variable of rpc.
361 */
362 public static final String RPC_INPUT_VAR_NAME = "inputVar";
363
364 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530365 * Static attribute for new line.
366 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530367 public static final String EQUAL = "=";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530368
369 /**
370 * Static attribute for slash syntax.
371 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530372 public static final String SLASH = File.separator;
Bharat saraswal2f11f652016-03-25 18:19:46 +0530373
374 /**
375 * Static attribute for add syntax.
376 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530377 public static final String ADD = "+";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530378
379 /**
Mahesh Poojary Huawei30c116a2016-07-14 17:49:50 +0530380 * Static attribute for single quote.
381 */
382 public static final String SINGLE_QUOTE = "\'";
383
384 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530385 * Static attribute for quotes.
386 */
b.janani1fef2732016-03-04 12:29:05 +0530387 public static final String QUOTES = "\"";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530388
389 /**
Mahesh Poojary Huawei30c116a2016-07-14 17:49:50 +0530390 * Static attribute for zero.
391 */
392 public static final String ZERO = "0";
393
394 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530395 * Static attribute for ampersand.
396 */
b.janani1fef2732016-03-04 12:29:05 +0530397 public static final String AND = "&";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530398
399 /**
400 * Static attribute for comma.
401 */
b.janani1fef2732016-03-04 12:29:05 +0530402 public static final String COMMA = ",";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530403
404 /**
Bharat saraswalb551aae2016-07-14 15:18:20 +0530405 * Static attribute for class.
406 */
407 public static final String CLASS_STRING = "Class";
408
409 /**
410 * Static attribute for put.
411 */
412 public static final String PUT = "put";
413
414 /**
415 * Static attribute for get.
416 */
417 public static final String GET = "get";
418
419 /**
janani be18b5342016-07-13 21:06:41 +0530420 * Static attribute for slash character.
421 */
422 public static final char CHAR_OF_SLASH = '/';
423
424 /**
425 * Static attribute for open square bracket character.
426 */
427 public static final char CHAR_OF_OPEN_SQUARE_BRACKET = '[';
428
429 /**
430 * Static attribute for close square bracket character.
431 */
432 public static final char CHAR_OF_CLOSE_SQUARE_BRACKET = ']';
433
434 /**
435 * Static attribute for slash string.
436 */
437 public static final String SLASH_FOR_STRING = "/";
438
439 /**
440 * Static attribute for open square bracket.
441 */
442 public static final String OPEN_SQUARE_BRACKET = "[";
443
444 /**
445 * Static attribute for ancestor accessor.
446 */
447 public static final String ANCESTOR_ACCESSOR = "..";
448
449 /**
450 * Static attribute for ancestor accessor along with path.
451 */
452 public static final String ANCESTOR_ACCESSOR_IN_PATH = "../";
453
454 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530455 * Static attribute for add syntax.
456 */
b.janani1fef2732016-03-04 12:29:05 +0530457 public static final String ADD_STRING = "add";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530458
459 /**
Mahesh Poojary Huawei30c116a2016-07-14 17:49:50 +0530460 * Static attribute for string replace syntax.
461 */
462 public static final String REPLACE_STRING = "replace";
463
464 /**
465 * Static attribute for string trim syntax.
466 */
467 public static final String TRIM_STRING = "trim";
468
469 /**
470 * Static attribute for string split syntax.
471 */
472 public static final String SPLIT_STRING = "split";
473
474 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530475 * Static attribute for from syntax.
476 */
477 public static final String FROM_STRING_METHOD_NAME = "fromString";
478
479 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530480 * Static attribute for check not null syntax.
481 */
b.janani1fef2732016-03-04 12:29:05 +0530482 public static final String CHECK_NOT_NULL_STRING = "checkNotNull";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530483
484 /**
485 * Static attribute for hash code syntax.
486 */
b.janani1fef2732016-03-04 12:29:05 +0530487 public static final String HASH_CODE_STRING = "hashCode";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530488
489 /**
490 * Static attribute for equals syntax.
491 */
b.janani1fef2732016-03-04 12:29:05 +0530492 public static final String EQUALS_STRING = "equals";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530493
494 /**
495 * Static attribute for object.
496 */
b.janani1fef2732016-03-04 12:29:05 +0530497 public static final String OBJECT_STRING = "Object";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530498
499 /**
500 * Static attribute for instance of syntax.
501 */
b.janani1fef2732016-03-04 12:29:05 +0530502 public static final String INSTANCE_OF = " instanceof ";
503
Bharat saraswal2f11f652016-03-25 18:19:46 +0530504 /**
505 * Static attribute for value syntax.
506 */
b.janani1fef2732016-03-04 12:29:05 +0530507 public static final String VALUE = "value";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530508
509 /**
510 * Static attribute for suffix s.
511 */
Bharat saraswale2d51d62016-03-23 19:40:35 +0530512 public static final String SUFFIX_S = "s";
b.janani1fef2732016-03-04 12:29:05 +0530513
Bharat saraswal2f11f652016-03-25 18:19:46 +0530514 /**
515 * Static attribute for if.
516 */
b.janani1fef2732016-03-04 12:29:05 +0530517 public static final String IF = "if";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530518
519 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530520 * Static attribute for of.
521 */
b.janani1fef2732016-03-04 12:29:05 +0530522 public static final String OF = "of";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530523
524 /**
525 * Static attribute for other.
526 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530527 public static final String OTHER = "other";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530528
529 /**
530 * Static attribute for obj syntax.
531 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530532 public static final String OBJ = "obj";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530533
534 /**
535 * Static attribute for hash syntax.
536 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530537 public static final String HASH = "hash";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530538
539 /**
540 * Static attribute for to syntax.
541 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530542 public static final String TO = "to";
b.janani1fef2732016-03-04 12:29:05 +0530543
Bharat saraswal2f11f652016-03-25 18:19:46 +0530544 /**
545 * Static attribute for true syntax.
546 */
b.janani1fef2732016-03-04 12:29:05 +0530547 public static final String TRUE = "true";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530548
549 /**
550 * Static attribute for false syntax.
551 */
b.janani1fef2732016-03-04 12:29:05 +0530552 public static final String FALSE = "false";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530553
554 /**
555 * Static attribute for org.
556 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530557 public static final String ORG = "org";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530558
559 /**
560 * Static attribute for temp.
561 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530562 public static final String TEMP = "temp";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530563
564 /**
565 * Static attribute for YANG file directory.
566 */
Vinod Kumar S38046502016-03-23 15:30:27 +0530567 public static final String YANG_RESOURCES = "yang/resources";
Bharat saraswal708abc02016-02-12 20:48:30 +0530568
569 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530570 * Static attribute for diamond close bracket syntax.
Bharat saraswal708abc02016-02-12 20:48:30 +0530571 */
572 public static final String DIAMOND_OPEN_BRACKET = "<";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530573
574 /**
575 * Static attribute for diamond close bracket syntax.
576 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530577 public static final String DIAMOND_CLOSE_BRACKET = ">";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530578
579 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530580 * Static attribute for exception syntax.
Bharat saraswal2f11f652016-03-25 18:19:46 +0530581 */
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530582 public static final String EXCEPTION = "Exception";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530583
584 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530585 * Static attribute for exception variable syntax.
Bharat saraswal2f11f652016-03-25 18:19:46 +0530586 */
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530587 public static final String EXCEPTION_VAR = "e";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530588
589 /**
590 * Static attribute for open parenthesis syntax.
591 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530592 public static final String OPEN_PARENTHESIS = "(";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530593
594 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +0530595 * Static attribute for received syntax.
596 */
597 public static final String RECEIVED_OBJECT = "recv";
598
599 /**
Bharat saraswalc0e04842016-05-12 13:16:57 +0530600 * Static attribute for switch syntax.
601 */
602 public static final String SWITCH = "switch";
603
604 /**
605 * Static attribute for case syntax.
606 */
607 public static final String CASE = "case";
608
609 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530610 * Static attribute for temp val syntax.
611 */
612 public static final String TMP_VAL = "tmpVal";
613
614 /**
615 * From string parameter name.
616 */
617 public static final String FROM_STRING_PARAM_NAME = "valInString";
618
619 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530620 * Static attribute for close parenthesis syntax.
621 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530622 public static final String CLOSE_PARENTHESIS = ")";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530623
624 /**
625 * Static attribute for open curly bracket syntax.
626 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530627 public static final String OPEN_CURLY_BRACKET = "{";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530628
629 /**
630 * Static attribute for close curly bracket syntax.
631 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530632 public static final String CLOSE_CURLY_BRACKET = "}";
633
634 /**
Mahesh Poojary Huawei46fb4db2016-07-14 12:38:17 +0530635 * Static attribute for square brackets syntax.
636 */
637 public static final String SQUARE_BRACKETS = "[]";
638
639 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530640 * Static attribute for getter method prefix.
Bharat saraswal708abc02016-02-12 20:48:30 +0530641 */
642 public static final String GET_METHOD_PREFIX = "get";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530643
644 /**
645 * Static attribute for setter method prefix.
646 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530647 public static final String SET_METHOD_PREFIX = "set";
648
649 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +0530650 * Static attribute for get filter leaf flags.
651 */
652 public static final String GET_FILTER_LEAF = "getFilterLeafFlags";
653
654 /**
655 * Static attribute for get filter leaf list flags.
656 */
657 public static final String GET_FILTER_LEAF_LIST = "getFilterLeafListFlags";
658
659 /**
660 * Static attribute for filter leaf flags.
661 */
662 public static final String FILTER_LEAF = "filterLeafFlags";
663
664 /**
665 * Static attribute for filter leaf list flags.
666 */
667 public static final String FILTER_LEAF_LIST = "filterLeafListFlags";
668
669 /**
670 * Static attribute for get select leaf flags.
671 */
672 public static final String GET_SELECT_LEAF = "getSelectLeafFlags";
673
674 /**
675 * Static attribute for get select leaf list flags.
676 */
677 public static final String GET_SELECT_LEAF_LIST = "getSelectLeafListFlags";
678
679 /**
680 * Static attribute for get operation type.
681 */
682 public static final String GET_OPERATION_TYPE = "getOpertionType";
683
684 /**
685 * Static attribute for set operation type.
686 */
687 public static final String SET_OPERATION_TYPE = "setOpertionType";
688
689 /**
690 * Static attribute for select leaf flags.
691 */
692 public static final String SELECT_LEAF = "selectLeafFlags";
693
694 /**
695 * Static attribute for select leaf list flags.
696 */
697 public static final String SELECT_LEAF_LIST = "selectLeafListFlags";
698
699 /**
700 * Static attribute for op param type.
701 */
702 public static final String OP_PARAM_TYPE = "opParamType";
703
704 /**
705 * Static attribute for is filter content match method prefix.
706 */
707 public static final String FILTER_CONTENT_MATCH = "isFilterContentMatch";
708
709 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530710 * Static attribute for four space indentation.
Bharat saraswal708abc02016-02-12 20:48:30 +0530711 */
712 public static final String FOUR_SPACE_INDENTATION = " ";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530713
714 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +0530715 * Static attribute for not syntax.
716 */
717 public static final String NOT = "!";
718
719 /**
Gaurav Agrawal338735b2016-04-18 18:53:11 +0530720 * Static attribute for try syntax.
721 */
722 public static final String TRY = "try";
723
724 /**
725 * Static attribute for catch syntax.
726 */
727 public static final String CATCH = "catch";
728
729 /**
Bharat saraswalb1170bd2016-07-14 13:26:18 +0530730 * Static attribute for super syntax.
731 */
732 public static final String SUPER = "super";
733
734 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +0530735 * Static attribute for merge syntax.
736 */
737 public static final String MERGE = "MERGE,";
738
739 /**
740 * Static attribute for replace syntax.
741 */
742 public static final String REPLACE = "REPLACE,";
743
744 /**
745 * Static attribute for create syntax.
746 */
747 public static final String CREATE = "CREATE,";
748
749 /**
750 * Static attribute for delete syntax.
751 */
752 public static final String DELETE = "DELETE,";
753
754 /**
755 * Static attribute for remove syntax.
756 */
757 public static final String REMOVE = "REMOVE";
758
759 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530760 * Static attribute for eight space indentation.
761 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530762 public static final String EIGHT_SPACE_INDENTATION = FOUR_SPACE_INDENTATION + FOUR_SPACE_INDENTATION;
Bharat saraswal2f11f652016-03-25 18:19:46 +0530763
764 /**
765 * Static attribute for twelve space indentation.
766 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530767 public static final String TWELVE_SPACE_INDENTATION = FOUR_SPACE_INDENTATION + EIGHT_SPACE_INDENTATION;
Bharat saraswal2f11f652016-03-25 18:19:46 +0530768
769 /**
770 * Static attribute for sixteen space indentation.
771 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530772 public static final String SIXTEEN_SPACE_INDENTATION = EIGHT_SPACE_INDENTATION + EIGHT_SPACE_INDENTATION;
773
774 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530775 * Static attribute for generated code path.
Bharat saraswal708abc02016-02-12 20:48:30 +0530776 */
Bharat saraswal8f2a6c52016-03-09 18:34:56 +0530777 public static final String YANG_GEN_DIR = "src/main/java/";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530778
779 /**
780 * Static attribute for base package.
781 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530782 public static final String DEFAULT_BASE_PKG = "org.onosproject.yang.gen";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530783
784 /**
785 * Static attribute for YANG date prefix.
786 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530787 public static final String REVISION_PREFIX = "rev";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530788
789 /**
janani bde4ffab2016-04-15 16:18:30 +0530790 * Static attribute for YANG automatic prefix for identifiers with keywords and beginning with digits.
791 */
792 public static final String YANG_AUTO_PREFIX = "yangAutoPrefix";
793
794 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530795 * Static attribute for YANG version perifx.
796 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530797 public static final String VERSION_PREFIX = "v";
798
799 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530800 * Static attribute for private modifier.
Bharat saraswal708abc02016-02-12 20:48:30 +0530801 */
802 public static final String PRIVATE = "private";
Bharat saraswal708abc02016-02-12 20:48:30 +0530803
804 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530805 * Static attribute for public modifier.
Bharat saraswal708abc02016-02-12 20:48:30 +0530806 */
Bharat saraswal2f11f652016-03-25 18:19:46 +0530807 public static final String PUBLIC = "public";
808
809 /**
Shankara-Huaweidf7b9ca2016-07-14 11:35:34 +0530810 * Static attribute for abstract modifier.
811 */
812 public static final String ABSTRACT = "abstract";
813
814 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +0530815 * Static attribute for protected modifier.
816 */
817 public static final String PROTECTED = "protected";
818
819 /**
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530820 * Void java type.
821 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530822 public static final String VOID = "void";
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530823
824 /**
825 * String built in java type.
826 */
Bharat saraswale2d51d62016-03-23 19:40:35 +0530827 public static final String STRING_DATA_TYPE = "String";
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530828
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530829 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530830 * Java.lang.* packages.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530831 */
832 public static final String JAVA_LANG = "java.lang";
833
834 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530835 * Java.math.* packages.
836 */
837 public static final String JAVA_MATH = "java.math";
838
839 /**
840 * Boolean built in java type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530841 */
Bharat saraswale2d51d62016-03-23 19:40:35 +0530842 public static final String BOOLEAN_DATA_TYPE = "boolean";
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530843
844 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530845 * BigInteger built in java type.
846 */
847 public static final String BIG_INTEGER = "BigInteger";
848
849 /**
Mahesh Poojary Huawei46fb4db2016-07-14 12:38:17 +0530850 * BigDecimal built in java type.
851 */
852 public static final String BIG_DECIMAL = "BigDecimal";
853
854 /**
855 * BitSet built in java type.
856 */
857 public static final String BIT_SET = "BitSet";
858
859 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530860 * Byte java built in type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530861 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530862 public static final String BYTE = "byte";
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530863
864 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530865 * Short java built in type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530866 */
867 public static final String SHORT = "short";
868
869 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530870 * Int java built in type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530871 */
872 public static final String INT = "int";
873
874 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530875 * Long java built in type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530876 */
877 public static final String LONG = "long";
878
879 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530880 * Double java built in type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530881 */
Bharat saraswal708abc02016-02-12 20:48:30 +0530882 public static final String DOUBLE = "double";
883
884 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530885 * Boolean built in java wrapper type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530886 */
887 public static final String BOOLEAN_WRAPPER = "Boolean";
888
889 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530890 * Byte java built in wrapper type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530891 */
892 public static final String BYTE_WRAPPER = "Byte";
893
894 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530895 * Short java built in wrapper type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530896 */
897 public static final String SHORT_WRAPPER = "Short";
898
899 /**
900 * Integer java built in wrapper type.
901 */
902 public static final String INTEGER_WRAPPER = "Integer";
903
904 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530905 * Long java built in wrapper type.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530906 */
907 public static final String LONG_WRAPPER = "Long";
908
909 /**
Bharat saraswalb551aae2016-07-14 15:18:20 +0530910 * Static varibale for question mark.
Vinod Kumar Sc4216002016-03-03 19:55:30 +0530911 */
Bharat saraswalb551aae2016-07-14 15:18:20 +0530912 public static final String QUESTION_MARK = "?";
Mahesh Poojary Huawei46fb4db2016-07-14 12:38:17 +0530913
914 /**
Bharat saraswale2d51d62016-03-23 19:40:35 +0530915 * List of keywords in java, this is used for checking if the input does not contain these keywords.
b.janani1fef2732016-03-04 12:29:05 +0530916 */
Bharat saraswal2f11f652016-03-25 18:19:46 +0530917 public static final List<String> JAVA_KEY_WORDS = Arrays.asList(
918 "abstract", "assert", "boolean", "break", "byte", "case", "catch", "char", "class", "const", "continue",
919 "default", "do", "double", "else", "extends", "false", "final", "finally", "float", "for", "goto", "if",
920 "implements", "import", "instanceof", "int", "interface", "long", "native", "new", "null", "package",
921 "private", "protected", "public", "return", "short", "static", "strictfp", "super", "switch",
922 "synchronized", "this", "throw", "throws", "transient", "true", "try", "void", "volatile", "while");
b.janani1fef2732016-03-04 12:29:05 +0530923
924 /**
janani bde4ffab2016-04-15 16:18:30 +0530925 * Static attribute for regex for all the special characters.
b.janani1fef2732016-03-04 12:29:05 +0530926 */
janani bde4ffab2016-04-15 16:18:30 +0530927 public static final String REGEX_WITH_ALL_SPECIAL_CHAR = "\\p{Punct}+";
928
929 /**
930 * Static attribute for regex for three special characters used in identifier.
931 */
932 public static final String REGEX_FOR_IDENTIFIER_SPECIAL_CHAR = "[. _ -]+";
933
934 /**
935 * Static attribute for regex for period.
936 */
937 public static final String REGEX_FOR_PERIOD = "[.]";
938
939 /**
940 * Static attribute for regex for underscore.
941 */
942 public static final String REGEX_FOR_UNDERSCORE = "[_]";
943
944 /**
945 * Static attribute for regex for hyphen.
946 */
947 public static final String REGEX_FOR_HYPHEN = "[-]";
Bharat saraswal2f11f652016-03-25 18:19:46 +0530948
949 /**
950 * Static attribute for regex for digits.
951 */
b.janani1fef2732016-03-04 12:29:05 +0530952 public static final String REGEX_FOR_FIRST_DIGIT = "\\d.*";
953
954 /**
janani b4a6711a2016-05-17 13:12:22 +0530955 * Static attribute for regex with digits.
956 */
957 public static final String REGEX_WITH_DIGITS = "(?=\\d+)";
958
959 /**
janani bde4ffab2016-04-15 16:18:30 +0530960 * Static attribute for regex for single letter.
961 */
962 public static final String REGEX_FOR_SINGLE_LETTER = "[a-zA-Z]";
963
964 /**
965 * Static attribute for regex for digits with single letter.
966 */
967 public static final String REGEX_FOR_DIGITS_WITH_SINGLE_LETTER = "[0-9]+[a-zA-Z]";
968
969 /**
janani b4a6711a2016-05-17 13:12:22 +0530970 * Static attribute for regex with uppercase.
971 */
972 public static final String REGEX_WITH_UPPERCASE = "(?=\\p{Upper})";
973
974 /**
975 * Static attribute for regex for single capital case letter.
976 */
977 public static final String REGEX_WITH_SINGLE_CAPITAL_CASE = "[A-Z]";
978
979 /**
980 * Static attribute for regex for capital case letter with any number of digits and small case letters.
981 */
982 public static final String REGEX_WITH_SINGLE_CAPITAL_CASE_AND_DIGITS_SMALL_CASES = "[A-Z][0-9a-z]+";
983
984 /**
janani bdd1314f2016-05-19 17:39:50 +0530985 * Static attribute for regex for any string ending with service.
986 */
987 public static final String REGEX_FOR_ANY_STRING_ENDING_WITH_SERVICE = ".+Service";
988
989 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530990 * Static attribute for class syntax.
Bharat saraswal708abc02016-02-12 20:48:30 +0530991 */
992 public static final String CLASS = "class";
Bharat saraswal708abc02016-02-12 20:48:30 +0530993
994 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +0530995 * Static attribute for builder syntax.
996 */
997 public static final String BUILDER = "Builder";
998
999 /**
VinodKumarS-Huaweicb3a1f52016-05-10 17:58:57 +05301000 * Static attribute for manager syntax.
1001 */
1002 public static final String MANAGER = "Manager";
1003
1004 /**
1005 * Static attribute for service syntax.
1006 */
1007 public static final String SERVICE = "Service";
1008
VinodKumarS-Huaweicb3a1f52016-05-10 17:58:57 +05301009 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +05301010 * Static attribute for interface syntax.
1011 */
1012 public static final String INTERFACE = "interface";
1013
1014 /**
1015 * Static attribute for enum syntax.
1016 */
1017 public static final String ENUM = "enum";
1018
1019 /**
Bharat saraswal33dfa012016-05-17 19:59:16 +05301020 * Static attribute for type syntax.
1021 */
1022 public static final String TYPE = "Type";
1023
1024 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +05301025 * Static attribute for static syntax.
1026 */
1027 public static final String STATIC = "static";
1028
1029 /**
1030 * Static attribute for final syntax.
1031 */
1032 public static final String FINAL = "final";
1033
1034 /**
1035 * Static attribute for package syntax.
1036 */
1037 public static final String PACKAGE = "package";
1038
1039 /**
1040 * Static attribute for import syntax.
1041 */
1042 public static final String IMPORT = "import ";
1043
1044 /**
1045 * Static attribute for null syntax.
1046 */
1047 public static final String NULL = "null";
1048
1049 /**
1050 * Static attribute for return syntax.
1051 */
1052 public static final String RETURN = "return";
1053
1054 /**
1055 * Static attribute for java new syntax.
1056 */
1057 public static final String NEW = "new";
1058
1059 /**
1060 * Static attribute for this syntax.
1061 */
1062 public static final String THIS = "this";
1063
1064 /**
1065 * Static attribute for implements syntax.
1066 */
1067 public static final String IMPLEMENTS = "implements";
1068
1069 /**
1070 * Static attribute for extends syntax.
1071 */
1072 public static final String EXTEND = "extends";
1073
1074 /**
Gaurav Agrawal56527662016-04-20 15:49:17 +05301075 * Static attribute for service interface suffix syntax.
1076 */
1077 public static final String SERVICE_METHOD_STRING = "Service";
1078
1079 /**
VinodKumarS-Huaweicb3a1f52016-05-10 17:58:57 +05301080 * For event file generation.
1081 */
1082 public static final String EVENT_STRING = "Event";
1083
1084 /**
1085 * For event listener file generation.
1086 */
1087 public static final String EVENT_LISTENER_STRING = "Listener";
1088
1089 /**
Bharat saraswal33dfa012016-05-17 19:59:16 +05301090 * For event subject file generation.
1091 */
1092 public static final String EVENT_SUBJECT_NAME_SUFFIX = "EventSubject";
1093
1094 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +05301095 * Static attribute for impl syntax.
1096 */
1097 public static final String IMPL = "Impl";
1098
1099 /**
1100 * Static attribute for build method syntax.
1101 */
1102 public static final String BUILD = "build";
1103
1104 /**
1105 * Static attribute for object.
1106 */
1107 public static final String OBJECT = "Object";
1108
1109 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +05301110 * Static attribute for app instance.
1111 */
1112 public static final String APP_INSTANCE = "appInstance";
1113
1114 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +05301115 * Static attribute for override annotation.
1116 */
1117 public static final String OVERRIDE = "@Override";
1118
1119 /**
Bharat saraswalb551aae2016-07-14 15:18:20 +05301120 * Static attribute for collections.
Bharat saraswal708abc02016-02-12 20:48:30 +05301121 */
b.janani1fef2732016-03-04 12:29:05 +05301122 public static final String COLLECTION_IMPORTS = "java.util";
Bharat saraswal2f11f652016-03-25 18:19:46 +05301123
1124 /**
Bharat saraswalb551aae2016-07-14 15:18:20 +05301125 * Static attribute for map.
1126 */
1127 public static final String MAP = "Map";
1128
1129 /**
1130 * Static attribute for hash map.
1131 */
1132 public static final String HASH_MAP = "HashMap";
1133
1134
1135 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +05301136 * Static attribute for more object import package.
1137 */
Vinod Kumar S38046502016-03-23 15:30:27 +05301138 public static final String GOOGLE_MORE_OBJECT_IMPORT_PKG = "com.google.common.base";
Bharat saraswal2f11f652016-03-25 18:19:46 +05301139
1140 /**
1141 * Static attribute for more object import class.
1142 */
Vinod Kumar S38046502016-03-23 15:30:27 +05301143 public static final String GOOGLE_MORE_OBJECT_IMPORT_CLASS = "MoreObjects;\n";
Bharat saraswal2f11f652016-03-25 18:19:46 +05301144
1145 /**
1146 * Static attribute for to string method.
1147 */
Vinod Kumar S38046502016-03-23 15:30:27 +05301148 public static final String GOOGLE_MORE_OBJECT_METHOD_STRING = " MoreObjects.toStringHelper(getClass())";
Bharat saraswal2f11f652016-03-25 18:19:46 +05301149
1150 /**
1151 * Static attribute for java utilities import package.
1152 */
Vinod Kumar S38046502016-03-23 15:30:27 +05301153 public static final String JAVA_UTIL_OBJECTS_IMPORT_PKG = "java.util";
Bharat saraswal2f11f652016-03-25 18:19:46 +05301154
1155 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +05301156 * Static attribute for bitset.
1157 */
1158 public static final String BITSET = "BitSet";
1159
1160 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +05301161 * Static attribute for java utilities objects import class.
1162 */
Vinod Kumar S38046502016-03-23 15:30:27 +05301163 public static final String JAVA_UTIL_OBJECTS_IMPORT_CLASS = "Objects;\n";
Bharat saraswal2f11f652016-03-25 18:19:46 +05301164
1165 /**
Mahesh Poojary Huawei30c116a2016-07-14 17:49:50 +05301166 * Static attribute for java utilities import base64 class.
1167 */
1168 public static final String JAVA_UTIL_IMPORT_BASE64_CLASS = "Base64;\n";
1169
1170 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +05301171 * Static attribute for AugmentedInfo class import package.
1172 */
Bharat saraswalb551aae2016-07-14 15:18:20 +05301173 public static final String YANG_AUGMENTED_INFO_CLASS_IMPORT_PKG = "org.onosproject.yangutils.datamodel";
Bharat saraswalcc1cdab2016-04-16 02:28:25 +05301174
1175 /**
1176 * Static attribute for AugmentedInfo class import class.
1177 */
Bharat saraswalb551aae2016-07-14 15:18:20 +05301178 public static final String YANG_AUGMENTED_INFO_CLASS_IMPORT_CLASS = "YangAugmentedInfo;\n";
Bharat saraswalcc1cdab2016-04-16 02:28:25 +05301179
1180 /**
1181 * Static attribute for augmentation class.
1182 */
Bharat saraswald50c6382016-07-14 21:57:13 +05301183 public static final String AUGMENTED_INFO = "AugmentedInfo";
Bharat saraswalcc1cdab2016-04-16 02:28:25 +05301184
1185 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +05301186 * Static attribute for AugmentedInfo class.
1187 */
Bharat saraswalb551aae2016-07-14 15:18:20 +05301188 public static final String YANG_AUGMENTED_INFO = "YangAugmentedInfo";
Bharat saraswalcc1cdab2016-04-16 02:28:25 +05301189
1190 /**
Bharat saraswalb551aae2016-07-14 15:18:20 +05301191 * Static attribute for augmented.
Bharat saraswalab4c6ba2016-05-17 14:19:38 +05301192 */
Bharat saraswalb551aae2016-07-14 15:18:20 +05301193 public static final String AUGMENTED = "Augmented";
VinodKumarS-Huawei2ee9e7e2016-06-01 14:30:22 +05301194
Bharat saraswalab4c6ba2016-05-17 14:19:38 +05301195 /**
Bharat saraswal2f11f652016-03-25 18:19:46 +05301196 * Static attribute for list.
1197 */
Bharat saraswal708abc02016-02-12 20:48:30 +05301198 public static final String LIST = "List";
Bharat saraswal2f11f652016-03-25 18:19:46 +05301199
1200 /**
Bharat saraswalc0e04842016-05-12 13:16:57 +05301201 * Comment to be added for autogenerated impl methods.
VinodKumarS-Huaweicb3a1f52016-05-10 17:58:57 +05301202 */
1203 public static final String YANG_UTILS_TODO = "//TODO: YANG utils generated code";
1204
1205 /**
Bharat saraswal33dfa012016-05-17 19:59:16 +05301206 * Static attribute for activate annotation.
1207 */
1208 public static final String ACTIVATE_ANNOTATION = "@Activate\n";
1209
1210 /**
1211 * Static attribute for activate.
1212 */
1213 public static final String ACTIVATE = "activate";
1214
1215 /**
1216 * Static attribute for activate annotation import.
1217 */
1218 public static final String ACTIVATE_ANNOTATION_IMPORT = "import org.apache.felix.scr.annotations.Activate;\n";
1219
1220 /**
1221 * Static attribute for deactivate annotation.
1222 */
1223 public static final String DEACTIVATE_ANNOTATION = "@Deactivate\n";
1224
1225 /**
1226 * Static attribute for deactivate.
1227 */
1228 public static final String DEACTIVATE = "deactivate";
1229
1230 /**
1231 * Static attribute for deactivate annotation import.
1232 */
1233 public static final String DEACTIVATE_ANNOTATION_IMPORT =
1234 "import org.apache.felix.scr.annotations.Deactivate;\n";
1235
1236 /**
1237 * Static attribute for component annotation.
1238 */
1239 public static final String COMPONENT_ANNOTATION = "@Component";
1240
1241 /**
VinodKumarS-Huawei2ee9e7e2016-06-01 14:30:22 +05301242 * Static attribute for component.
1243 */
1244 public static final String COMPONENT = "Component";
1245
1246 /**
Bharat saraswal33dfa012016-05-17 19:59:16 +05301247 * Static attribute for immediate.
1248 */
1249 public static final String IMMEDIATE = "immediate";
1250
1251 /**
1252 * Static attribute for component annotation import.
1253 */
1254 public static final String COMPONENT_ANNOTATION_IMPORT =
1255 "import org.apache.felix.scr.annotations.Component;\n";
1256
1257 /**
1258 * Static attribute for service annotation.
1259 */
1260 public static final String SERVICE_ANNOTATION = "@Service\n";
1261
1262 /**
1263 * Static attribute for service annotation import.
1264 */
1265 public static final String SERVICE_ANNOTATION_IMPORT =
1266 "import org.apache.felix.scr.annotations.Service;\n";
1267
1268 /**
1269 * Static attribute for logger factory import.
1270 */
1271 public static final String LOGGER_FACTORY_IMPORT =
1272 "import static org.slf4j.LoggerFactory.getLogger;\n";
1273
1274 /**
1275 * Static attribute for logger import.
1276 */
1277 public static final String LOGGER_IMPORT =
1278 "import org.slf4j.Logger;\n";
1279
1280 /**
1281 * Static attribute for logger statement.
1282 */
1283 public static final String LOGGER_STATEMENT =
1284 "\n private final Logger log = getLogger(getClass());\n";
1285
1286 /**
1287 * Static attribute for logger statement for started.
1288 */
1289 public static final String STARTED_LOG_INFO =
1290 "log.info(\"Started\");\n";
1291
1292 /**
1293 * Static attribute for logger statement for stopped.
1294 */
1295 public static final String STOPPED_LOG_INFO =
1296 "log.info(\"Stopped\");\n";
1297
1298 /**
1299 * Static attribute for AbstractEvent.
1300 */
1301 public static final String ABSTRACT_EVENT = "AbstractEvent";
1302
1303 /**
1304 * Static attribute for EventListener.
1305 */
1306 public static final String EVENT_LISTENER = "EventListener";
1307
1308 /**
Shankara-Huaweib9999eb2016-07-14 16:53:09 +05301309 * Static attribute for or operator.
1310 */
1311 public static final String OR_OPERATION = "||";
1312
1313 /**
Vidyashree Rama1db15562016-05-17 16:16:15 +05301314 * Static attribute for YANG file error.
1315 */
1316 public static final String YANG_FILE_ERROR = "YANG file error : ";
1317
1318 /**
1319 * Static attribute for unsupported error information.
1320 */
1321 public static final String UNSUPPORTED_YANG_CONSTRUCT = " is not supported.";
1322
1323 /**
1324 * Static attribute for currently unsupported error information.
1325 */
1326 public static final String CURRENTLY_UNSUPPORTED = " is not supported in current version, please check wiki" +
1327 " for YANG utils road map.";
1328
1329 /**
Vidyashree Rama210c01d2016-05-20 16:29:25 +05301330 * Static attribute for typedef linker error information.
1331 */
1332 public static final String TYPEDEF_LINKER_ERROR = "YANG file error: Unable to find base "
1333 + "typedef for given type";
1334
1335 /**
1336 * Static attribute for grouping linker error information.
1337 */
1338 public static final String GROUPING_LINKER_ERROR = "YANG file error: Unable to find base "
1339 + "grouping for given uses";
1340
1341 /**
janani be18b5342016-07-13 21:06:41 +05301342 * Static attribute for if-feature linker error information.
Vidyashree Ramadeac28b2016-06-20 15:12:43 +05301343 */
1344 public static final String FEATURE_LINKER_ERROR = "YANG file error: Unable to find feature "
1345 + "for given if-feature";
1346
1347 /**
janani be18b5342016-07-13 21:06:41 +05301348 * Static attribute for leafref linker error information.
1349 */
1350 public static final String LEAFREF_LINKER_ERROR = "YANG file error: Unable to find base "
1351 + "leaf/leaf-list for given leafref";
1352
1353 /**
Shankara-Huaweidf7b9ca2016-07-14 11:35:34 +05301354 * Static attribute for base linker error information.
1355 */
1356 public static final String BASE_LINKER_ERROR = "YANG file error: Unable to find base "
1357 + "identity for given base";
1358
1359 /**
1360 * Static attribute for identityref linker error information.
1361 */
1362 public static final String IDENTITYREF_LINKER_ERROR = "YANG file error: Unable to find base "
1363 + "identity for given base";
1364
1365 /**
VinodKumarS-Huawei2ee9e7e2016-06-01 14:30:22 +05301366 * Static attribute for reference.
1367 */
1368 public static final String REFERENCE = "Reference";
1369
1370 /**
1371 * Static attribute for ReferenceCardinality.
1372 */
1373 public static final String REFERENCE_CARDINALITY = "ReferenceCardinality";
1374
1375 /**
Bharat saraswal96dfef02016-06-16 00:29:12 +05301376 * Static attribute for jar.
1377 */
1378 public static final String JAR = "jar";
1379
1380 /**
Bharat saraswald50c6382016-07-14 21:57:13 +05301381 * Static attribute for for.
1382 */
1383 public static final String FOR = "for";
1384
1385 /**
1386 * Static attribute for YangAugmentedOpParamInfo.
1387 */
1388 public static final String YANG_AUGMENTED_OP_PARAM_INFO = "YangAugmentedOpParamInfo";
1389
1390 /**
1391 * Static attribute for YangAugmentedOpParamInfo.
1392 */
1393 public static final String YANG_AUGMENTED_OP_PARAM_INFO_CLASS = "YangAugmentedOpParamInfo;\n";
1394
1395 /**
1396 * Static attribute for IllegalArgumentException.
1397 */
1398 public static final String ILLEGAL_ARGUMENT_EXCEPTION = "IllegalArgumentException";
1399
1400 /**
1401 * Static attribute for IllegalArgumentException.
1402 */
1403 public static final String ILLEGAL_ARGUMENT_EXCEPTION_MSG = "\"provided augmented info is invalid for content " +
1404 "match.\"";
1405
1406 /**
1407 * Static attribute for throw.
1408 */
1409 public static final String THROW = "throw";
1410
1411 /**
1412 * Static attribute for baseClass().
1413 */
1414 public static final String BASE_CLASS = "BaseClass()";
1415
1416
1417 /**
Vidyashree Rama7142d9c2016-04-26 15:06:06 +05301418 * Creates an instance of util constants.
1419 */
1420 private UtilConstants() {
1421 }
Bharat saraswal708abc02016-02-12 20:48:30 +05301422}