View Javadoc
1   /*
2    *    Copyright 2006-2026 the original author or authors.
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    *       https://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  package org.mybatis.generator.config;
17  
18  /**
19   * This class holds constants for all properties recognized by the different
20   * configuration elements. This helps document and maintain the different
21   * properties, and helps to avoid spelling errors.
22   *
23   * @author Jeff Butler
24   */
25  public class PropertyRegistry {
26      private PropertyRegistry() {
27      }
28  
29      public static final String ANY_ENABLE_SUB_PACKAGES = "enableSubPackages"; //$NON-NLS-1$
30  
31      /**
32       * recognized by table and java model generator.
33       */
34      public static final String ANY_ROOT_CLASS = "rootClass"; //$NON-NLS-1$
35      public static final String ANY_IMMUTABLE = "immutable"; //$NON-NLS-1$
36      public static final String ANY_CONSTRUCTOR_BASED = "constructorBased"; //$NON-NLS-1$
37      public static final String GENERATE_KOTLIN_V1_MODEL = "generateKotlinV1Model"; //$NON-NLS-1$
38  
39      /**
40       * recognized by table and java client generator.
41       */
42      public static final String ANY_ROOT_INTERFACE = "rootInterface"; //$NON-NLS-1$
43      public static final String ANY_INJECT_MODEL_INTO_ROOT_INTERFACE = "injectModelIntoRootInterface"; //$NON-NLS-1$
44      public static final String ANY_USE_SNAKE_CASE_IDENTIFIERS = "useSnakeCaseIdentifiers"; //$NON-NLS-1$
45  
46      public static final String TABLE_USE_ACTUAL_COLUMN_NAMES = "useActualColumnNames"; //$NON-NLS-1$
47      public static final String TABLE_USE_COMPOUND_PROPERTY_NAMES = "useCompoundPropertyNames"; //$NON-NLS-1$
48      public static final String TABLE_IGNORE_QUALIFIERS_AT_RUNTIME = "ignoreQualifiersAtRuntime"; //$NON-NLS-1$
49      public static final String TABLE_RUNTIME_CATALOG = "runtimeCatalog"; //$NON-NLS-1$
50      public static final String TABLE_RUNTIME_SCHEMA = "runtimeSchema"; //$NON-NLS-1$
51      public static final String TABLE_RUNTIME_TABLE_NAME = "runtimeTableName"; //$NON-NLS-1$
52      public static final String TABLE_MODEL_ONLY = "modelOnly"; //$NON-NLS-1$
53      public static final String TABLE_SELECT_ALL_ORDER_BY_CLAUSE = "selectAllOrderByClause"; //$NON-NLS-1$
54      public static final String TABLE_DYNAMIC_SQL_SUPPORT_CLASS_NAME = "dynamicSqlSupportClassName"; //$NON-NLS-1$
55      public static final String TABLE_DYNAMIC_SQL_TABLE_OBJECT_NAME = "dynamicSqlTableObjectName"; //$NON-NLS-1$
56  
57      public static final String CONTEXT_BEGINNING_DELIMITER = "beginningDelimiter"; //$NON-NLS-1$
58      public static final String CONTEXT_ENDING_DELIMITER = "endingDelimiter"; //$NON-NLS-1$
59      public static final String CONTEXT_AUTO_DELIMIT_KEYWORDS = "autoDelimitKeywords"; //$NON-NLS-1$
60      public static final String CONTEXT_JAVA_FILE_ENCODING = "javaFileEncoding"; //$NON-NLS-1$
61      public static final String CONTEXT_JAVA_FORMATTER = "javaFormatter"; //$NON-NLS-1$
62      public static final String CONTEXT_XML_FORMATTER = "xmlFormatter"; //$NON-NLS-1$
63      public static final String CONTEXT_KOTLIN_FORMATTER = "kotlinFormatter"; //$NON-NLS-1$
64      public static final String CONTEXT_KOTLIN_FILE_ENCODING = "kotlinFileEncoding"; //$NON-NLS-1$
65  
66      public static final String CLIENT_DYNAMIC_SQL_SUPPORT_PACKAGE = "dynamicSqlSupportPackage"; //$NON-NLS-1$
67  
68      public static final String TYPE_RESOLVER_FORCE_BIG_DECIMALS = "forceBigDecimals"; //$NON-NLS-1$
69  
70      public static final String MODEL_GENERATOR_TRIM_STRINGS = "trimStrings"; //$NON-NLS-1$
71      public static final String MODEL_GENERATOR_EXAMPLE_PACKAGE = "exampleTargetPackage"; //$NON-NLS-1$
72      public static final String MODEL_GENERATOR_EXAMPLE_PROJECT = "exampleTargetProject"; //$NON-NLS-1$
73  
74      public static final String COMMENT_GENERATOR_SUPPRESS_DATE = "suppressDate"; //$NON-NLS-1$
75      public static final String COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS = "suppressAllComments"; //$NON-NLS-1$
76      public static final String COMMENT_GENERATOR_ADD_REMARK_COMMENTS = "addRemarkComments"; //$NON-NLS-1$
77      public static final String COMMENT_GENERATOR_MINIMIZE_COMMENTS = "minimizeComments"; //$NON-NLS-1$
78  
79      public static final String COLUMN_OVERRIDE_FORCE_JAVA_TYPE = "forceJavaTypeIntoMapping"; //$NON-NLS-1$
80  }