• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

mybatis / generator / 2057

16 Feb 2026 08:58PM UTC coverage: 90.025% (+0.1%) from 89.916%
2057

push

github

web-flow
Merge pull request #1454 from jeffgbutler/generate-records

Support Generating JDK 16 Records in All Runtimes

2335 of 3103 branches covered (75.25%)

153 of 161 new or added lines in 31 files covered. (95.03%)

2 existing lines in 1 file now uncovered.

11633 of 12922 relevant lines covered (90.02%)

0.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.18
/core/mybatis-generator-core/src/main/java/org/mybatis/generator/config/Context.java
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
import static org.mybatis.generator.internal.util.StringUtility.isTrue;
19
import static org.mybatis.generator.internal.util.StringUtility.stringHasValue;
20
import static org.mybatis.generator.internal.util.messages.Messages.getString;
21

22
import java.util.ArrayList;
23
import java.util.Collections;
24
import java.util.List;
25
import java.util.Objects;
26
import java.util.Optional;
27
import java.util.stream.Stream;
28

29
import org.jspecify.annotations.Nullable;
30
import org.mybatis.generator.api.KnownRuntime;
31

32
public class Context extends PropertyHolder {
33
    private final String id;
34
    private final @Nullable JDBCConnectionConfiguration jdbcConnectionConfiguration;
35
    private final @Nullable ConnectionFactoryConfiguration connectionFactoryConfiguration;
36
    private final @Nullable SqlMapGeneratorConfiguration sqlMapGeneratorConfiguration;
37
    private final @Nullable JavaTypeResolverConfiguration javaTypeResolverConfiguration;
38
    private final JavaModelGeneratorConfiguration javaModelGeneratorConfiguration;
39
    private final @Nullable JavaClientGeneratorConfiguration javaClientGeneratorConfiguration;
40
    private final List<TableConfiguration> tableConfigurations;
41
    private final ModelType defaultModelType;
42
    private final String beginningDelimiter;
43
    private final String endingDelimiter;
44
    private final @Nullable Boolean autoDelimitKeywords;
45
    private final @Nullable CommentGeneratorConfiguration commentGeneratorConfiguration;
46
    private final List<PluginConfiguration> pluginConfigurations;
47
    private final @Nullable String targetRuntime;
48
    private final @Nullable String introspectedColumnImpl;
49

50
    protected Context(Builder builder) {
51
        super(builder);
1✔
52
        id = Objects.requireNonNull(builder.id, getString("ValidationError.16")); //$NON-NLS-1$
1✔
53
        defaultModelType = Objects.requireNonNullElseGet(builder.defaultModelType,
1✔
54
                () -> calculateDefaultModelType(builder.targetRuntime));
1✔
55
        tableConfigurations = Collections.unmodifiableList(builder.tableConfigurations);
1✔
56
        pluginConfigurations = Collections.unmodifiableList(builder.pluginConfigurations);
1✔
57
        commentGeneratorConfiguration = builder.commentGeneratorConfiguration;
1✔
58
        jdbcConnectionConfiguration = builder.jdbcConnectionConfiguration;
1✔
59
        connectionFactoryConfiguration = builder.connectionFactoryConfiguration;
1✔
60
        sqlMapGeneratorConfiguration = builder.sqlMapGeneratorConfiguration;
1✔
61
        javaTypeResolverConfiguration = builder.javaTypeResolverConfiguration;
1✔
62
        introspectedColumnImpl = builder.introspectedColumnImpl;
1✔
63
        javaModelGeneratorConfiguration = Objects.requireNonNull(builder.javaModelGeneratorConfiguration,
1✔
64
                getString("ValidationError.8", id)); //$NON-NLS-1$
1✔
65
        javaClientGeneratorConfiguration = builder.javaClientGeneratorConfiguration;
1✔
66
        targetRuntime = builder.targetRuntime;
1✔
67

68
        String property = getProperty(PropertyRegistry.CONTEXT_BEGINNING_DELIMITER);
1✔
69
        beginningDelimiter = property == null ? Defaults.DEFAULT_BEGINNING_DELIMITER : property;
1!
70

71
        property = getProperty(PropertyRegistry.CONTEXT_ENDING_DELIMITER);
1✔
72
        endingDelimiter = property == null ? Defaults.DEFAULT_ENDING_DELIMITER : property;
1!
73

74
        property = getProperty(PropertyRegistry.CONTEXT_AUTO_DELIMIT_KEYWORDS);
1✔
75
        autoDelimitKeywords = isTrue(property);
1✔
76
    }
1✔
77

78
    private ModelType calculateDefaultModelType(@Nullable String targetRuntime) {
79
        if (targetRuntime == null) {
1✔
80
            return ModelType.FLAT; // MyBatis Dynamic SQL is the default runtime
1✔
81
        } else {
82
            KnownRuntime knownRuntime = KnownRuntime.getByAlias(targetRuntime);
1✔
83
            if (knownRuntime.isDynamicSqlBased() || knownRuntime == KnownRuntime.MYBATIS3_SIMPLE) {
1✔
84
                return ModelType.FLAT;
1✔
85
            } else {
86
                return ModelType.CONDITIONAL;
1✔
87
            }
88
        }
89
    }
90

91
    public Optional<JavaClientGeneratorConfiguration> getJavaClientGeneratorConfiguration() {
92
        return Optional.ofNullable(javaClientGeneratorConfiguration);
1✔
93
    }
94

95
    public JavaModelGeneratorConfiguration getJavaModelGeneratorConfiguration() {
96
        return Objects.requireNonNull(javaModelGeneratorConfiguration);
1✔
97
    }
98

99
    public Optional<JavaTypeResolverConfiguration> getJavaTypeResolverConfiguration() {
100
        return Optional.ofNullable(javaTypeResolverConfiguration);
1✔
101
    }
102

103
    public Optional<SqlMapGeneratorConfiguration> getSqlMapGeneratorConfiguration() {
104
        return Optional.ofNullable(sqlMapGeneratorConfiguration);
1✔
105
    }
106

107
    /**
108
     * This method does a simple validate, it makes sure that all required fields have been filled in. It does not do
109
     * any more complex operations such as validating that database tables exist or validating that named columns exist
110
     *
111
     * @param errors
112
     *            the errors
113
     */
114
    public void validate(List<String> errors) {
115
        if (!stringHasValue(id)) {
1!
116
            errors.add(getString("ValidationError.16")); //$NON-NLS-1$
×
117
        }
118

119
        if (jdbcConnectionConfiguration == null && connectionFactoryConfiguration == null) {
1✔
120
            // must specify one
121
            errors.add(getString("ValidationError.10", id)); //$NON-NLS-1$
1✔
122
        } else if (jdbcConnectionConfiguration != null && connectionFactoryConfiguration != null) {
1✔
123
            // must not specify both
124
            errors.add(getString("ValidationError.10", id)); //$NON-NLS-1$
1✔
125
        } else if (jdbcConnectionConfiguration != null) {
1✔
126
            jdbcConnectionConfiguration.validate(errors);
1✔
127
        } else {
128
            connectionFactoryConfiguration.validate(errors);
1✔
129
        }
130

131
        javaModelGeneratorConfiguration.validate(errors, id);
1✔
132

133
        if (javaClientGeneratorConfiguration != null) {
1✔
134
            javaClientGeneratorConfiguration.validate(errors, id);
1✔
135
        }
136

137
        KnownRuntime knownRuntime = KnownRuntime.getByAlias(targetRuntime);
1✔
138
        if (knownRuntime.isLegacyMyBatis3Based()
1✔
139
                && javaClientGeneratorConfiguration != null
140
                && javaClientGeneratorConfiguration.requiresXmlMapper()
1✔
141
                && sqlMapGeneratorConfiguration == null) {
142
            errors.add(getString("ValidationError.9", id)); //$NON-NLS-1$
1✔
143
        }
144

145
        if (knownRuntime == KnownRuntime.MYBATIS3_DYNAMIC_SQL || knownRuntime == KnownRuntime.MYBATIS3_SIMPLE) {
1✔
146
            if (defaultModelType != ModelType.FLAT && defaultModelType != ModelType.RECORD) {
1!
NEW
147
                errors.add(getString("ValidationError.29", getId())); //$NON-NLS-1$
×
148
            }
149
        }
150

151
        if (sqlMapGeneratorConfiguration != null) {
1✔
152
            sqlMapGeneratorConfiguration.validate(errors, id);
1✔
153
        }
154

155
        if (tableConfigurations.isEmpty()) {
1✔
156
            errors.add(getString("ValidationError.3", id)); //$NON-NLS-1$
1✔
157
        } else {
158
            for (int i = 0; i < tableConfigurations.size(); i++) {
1✔
159
                TableConfiguration tc = tableConfigurations.get(i);
1✔
160

161
                tc.validate(errors, i, this);
1✔
162
            }
163
        }
164

165
        for (PluginConfiguration pluginConfiguration : pluginConfigurations) {
1✔
166
            pluginConfiguration.validate(errors, id);
1✔
167
        }
1✔
168
    }
1✔
169

170
    public String getId() {
171
        return id;
1✔
172
    }
173

174
    public ModelType getDefaultModelType() {
175
        return defaultModelType;
1✔
176
    }
177

178
    public String getBeginningDelimiter() {
179
        return beginningDelimiter;
1✔
180
    }
181

182
    public String getEndingDelimiter() {
183
        return endingDelimiter;
1✔
184
    }
185

186
    public Optional<CommentGeneratorConfiguration> getCommentGeneratorConfiguration() {
187
        return Optional.ofNullable(commentGeneratorConfiguration);
1✔
188
    }
189

190
    public Optional<String> getTargetRuntime() {
191
        return Optional.ofNullable(targetRuntime);
1✔
192
    }
193

194
    public Optional<String> getIntrospectedColumnImpl() {
195
        return Optional.ofNullable(introspectedColumnImpl);
1✔
196
    }
197

198

199
    public int getIntrospectionSteps() {
200
        int steps = 0;
1✔
201

202
        steps++; // connect to database
1✔
203

204
        // for each table:
205
        //
206
        // 1. Create introspected table implementation
207

208
        steps += tableConfigurations.size();
1✔
209

210
        return steps;
1✔
211
    }
212

213
    public Stream<PluginConfiguration> pluginConfigurations() {
214
        return pluginConfigurations.stream();
1✔
215
    }
216

217
    public List<TableConfiguration> tableConfigurations() {
218
        return tableConfigurations;
1✔
219
    }
220

221
    public boolean autoDelimitKeywords() {
222
        return autoDelimitKeywords != null && autoDelimitKeywords;
1!
223
    }
224

225
    public @Nullable ConnectionFactoryConfiguration getConnectionFactoryConfiguration() {
226
        return connectionFactoryConfiguration;
1✔
227
    }
228

229
    public @Nullable JDBCConnectionConfiguration getJDBCConnectionConfiguration() {
230
        return jdbcConnectionConfiguration;
1✔
231
    }
232

233
    public static class Builder extends AbstractBuilder<Builder> {
1✔
234
        private @Nullable String id;
235
        private @Nullable ModelType defaultModelType;
236
        private @Nullable String targetRuntime;
237
        private @Nullable String introspectedColumnImpl;
238
        private final List<PluginConfiguration> pluginConfigurations = new ArrayList<>();
1✔
239
        private final ArrayList<TableConfiguration> tableConfigurations = new ArrayList<>();
1✔
240
        private @Nullable CommentGeneratorConfiguration commentGeneratorConfiguration;
241
        private @Nullable JDBCConnectionConfiguration jdbcConnectionConfiguration;
242
        private @Nullable ConnectionFactoryConfiguration connectionFactoryConfiguration;
243
        private @Nullable SqlMapGeneratorConfiguration sqlMapGeneratorConfiguration;
244
        private @Nullable JavaTypeResolverConfiguration javaTypeResolverConfiguration;
245
        private @Nullable JavaModelGeneratorConfiguration javaModelGeneratorConfiguration;
246
        private @Nullable JavaClientGeneratorConfiguration javaClientGeneratorConfiguration;
247

248
        @Override
249
        protected Builder getThis() {
250
            return this;
1✔
251
        }
252

253
        public Context build() {
254
            return new Context(this);
1✔
255
        }
256

257
        public Builder withId(@Nullable String id) {
258
            this.id = id;
1✔
259
            return this;
1✔
260
        }
261

262
        public Builder withDefaultModelType(@Nullable ModelType defaultModelType) {
263
            this.defaultModelType = defaultModelType;
1✔
264
            return this;
1✔
265
        }
266

267
        public Builder withTargetRuntime(@Nullable String targetRuntime) {
268
            this.targetRuntime = targetRuntime;
1✔
269
            return this;
1✔
270
        }
271

272
        public Builder withIntrospectedColumnImpl(@Nullable String introspectedColumnImpl) {
273
            this.introspectedColumnImpl = introspectedColumnImpl;
1✔
274
            return this;
1✔
275
        }
276

277
        @SuppressWarnings("UnusedReturnValue")
278
        public Builder withPluginConfiguration(PluginConfiguration pluginConfiguration) {
279
            pluginConfigurations.add(pluginConfiguration);
1✔
280
            return this;
1✔
281
        }
282

283
        @SuppressWarnings("UnusedReturnValue")
284
        public Builder withTableConfiguration(TableConfiguration tableConfiguration) {
285
            tableConfigurations.add(tableConfiguration);
1✔
286
            return this;
1✔
287
        }
288

289
        @SuppressWarnings("UnusedReturnValue")
290
        public Builder withCommentGeneratorConfiguration(CommentGeneratorConfiguration commentGeneratorConfiguration) {
291
            this.commentGeneratorConfiguration = commentGeneratorConfiguration;
1✔
292
            return this;
1✔
293
        }
294

295
        @SuppressWarnings("UnusedReturnValue")
296
        public Builder withJdbcConnectionConfiguration(JDBCConnectionConfiguration jdbcConnectionConfiguration) {
297
            this.jdbcConnectionConfiguration = jdbcConnectionConfiguration;
1✔
298
            return this;
1✔
299
        }
300

301
        @SuppressWarnings("UnusedReturnValue")
302
        public Builder withSqlMapGeneratorConfiguration(SqlMapGeneratorConfiguration sqlMapGeneratorConfiguration) {
303
            this.sqlMapGeneratorConfiguration = sqlMapGeneratorConfiguration;
1✔
304
            return this;
1✔
305
        }
306

307
        public Builder withConnectionFactoryConfiguration(
308
                ConnectionFactoryConfiguration connectionFactoryConfiguration) {
309
            this.connectionFactoryConfiguration = connectionFactoryConfiguration;
1✔
310
            return this;
1✔
311
        }
312

313
        @SuppressWarnings("UnusedReturnValue")
314
        public Builder withJavaTypeResolverConfiguration(JavaTypeResolverConfiguration javaTypeResolverConfiguration) {
315
            this.javaTypeResolverConfiguration = javaTypeResolverConfiguration;
1✔
316
            return this;
1✔
317
        }
318

319
        public Builder withJavaModelGeneratorConfiguration(
320
                JavaModelGeneratorConfiguration javaModelGeneratorConfiguration) {
321
            this.javaModelGeneratorConfiguration = javaModelGeneratorConfiguration;
1✔
322
            return this;
1✔
323
        }
324

325
        @SuppressWarnings("UnusedReturnValue")
326
        public Builder withJavaClientGeneratorConfiguration(
327
                JavaClientGeneratorConfiguration javaClientGeneratorConfiguration) {
328
            this.javaClientGeneratorConfiguration = javaClientGeneratorConfiguration;
1✔
329
            return this;
1✔
330
        }
331
    }
332
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc