1941

Committed 12 Jan 2026 04:39PM UTC coverage: 88.75% (+0.4%) from 88.365%

Build # 1941

Build Type

Pull #1412

github

Committed by

web-flow

Commit Message

Merge b9b8be318 into 98a4124a3

Pull Request Pull Request #1412: Adopt JSpecify

Run Details

2331 of 3162 branches covered (73.72%)

1800 of 1949 new or added lines in 202 files covered. (92.36%)

18 existing lines in 10 files now uncovered.

11384 of 12827 relevant lines covered (88.75%)

0.89 hits per line

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

91.95

/core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/IntrospectedColumn.java

/*
 *    Copyright 2006-2026 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       https://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.mybatis.generator.api;

import java.sql.Types;
import java.util.Objects;
import java.util.Optional;
import java.util.Properties;

import org.jspecify.annotations.Nullable;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.config.Context;
import org.mybatis.generator.internal.util.StringUtility;

/**
 * This class holds information about an introspected column.
 *
 * @author Jeff Butler
 */
public class IntrospectedColumn {
    /**
     * Only nullable because instances of this class are built through introspection. Not null in practice.
     */
    protected @Nullable String actualColumnName;

    protected int jdbcType;

    /**
     * The platform specific data type name as reported from DatabaseMetadata.getColumns().
     *
     * <p>Only nullable because instances of this class are built through introspection. Not null in practice.
     */
    protected @Nullable String actualTypeName;

    protected @Nullable String jdbcTypeName;

    protected boolean nullable;

    protected int length;

    protected int scale;

    protected boolean identity;

    protected boolean isSequenceColumn;

    /**
     * Only nullable because instances of this class are built through introspection. Not null in practice.
     */
    protected @Nullable String javaProperty;

    /**
     * Only nullable because instances of this class are built through introspection. Not null in practice.
     */
    protected @Nullable FullyQualifiedJavaType fullyQualifiedJavaType;

    protected @Nullable String tableAlias;

    protected @Nullable String typeHandler;

    /**
     * Only nullable because instances of this class are built through introspection. Not null in practice.
     */
    protected @Nullable Context context;

    protected boolean isColumnNameDelimited;

    /**
     * Only nullable because instances of this class are built through introspection. Not null in practice.
     */
    protected @Nullable IntrospectedTable introspectedTable;

    protected final Properties properties;

    // any database comment associated with this column. May be null
    protected @Nullable String remarks;

    protected @Nullable String defaultValue;

    /**
     * true if the JDBC driver reports that this column is auto-increment.
     */
    protected boolean isAutoIncrement;

    /**
     * true if the JDBC driver reports that this column is generated.
     */
    protected boolean isGeneratedColumn;

    /**
     * True if there is a column override that defines this column as GENERATED ALWAYS.
     */
    protected boolean isGeneratedAlways;

    /**
     * Constructs a Column definition. This object holds all the information
     * about a column that is required to generate Java objects and SQL maps;
     */
    public IntrospectedColumn() {
        properties = new Properties();
    }

    public int getJdbcType() {
        return jdbcType;
    }

    public void setJdbcType(int jdbcType) {
        this.jdbcType = jdbcType;
    }

    public int getLength() {
        return length;
    }

    public void setLength(int length) {
        this.length = length;
    }

    public boolean isNullable() {
        return nullable;
    }

    public void setNullable(boolean nullable) {
        this.nullable = nullable;
    }

    public int getScale() {
        return scale;
    }

    public void setScale(int scale) {
        this.scale = scale;
    }

    /*
     * This method is primarily used for debugging, so we don't externalize the
     * strings
     */
    @Override
    public String toString() {
        return "Actual Column Name: " //$NON-NLS-1$
                + getActualColumnName()
                + ", JDBC Type: " //$NON-NLS-1$
                + jdbcType
                + ", Nullable: " //$NON-NLS-1$
                + nullable
                + ", Length: " //$NON-NLS-1$
                + length
                + ", Scale: " //$NON-NLS-1$
                + scale
                + ", Identity: " //$NON-NLS-1$
                + identity;
    }

    public void setActualColumnName(String actualColumnName) {
        this.actualColumnName = actualColumnName;
        isColumnNameDelimited = StringUtility.stringContainsSpace(actualColumnName);
    }

    public boolean isIdentity() {
        return identity;
    }

    public void setIdentity(boolean identity) {
        this.identity = identity;
    }

    public boolean isBLOBColumn() {
        String typeName = getJdbcTypeName();

        return "BINARY".equals(typeName) || "BLOB".equals(typeName) //$NON-NLS-1$ //$NON-NLS-2$
                || "CLOB".equals(typeName) || "LONGNVARCHAR".equals(typeName) //$NON-NLS-1$ //$NON-NLS-2$
                || "LONGVARBINARY".equals(typeName) || "LONGVARCHAR".equals(typeName) //$NON-NLS-1$ //$NON-NLS-2$
                || "NCLOB".equals(typeName) || "VARBINARY".equals(typeName); //$NON-NLS-1$ //$NON-NLS-2$
    }

    public boolean isStringColumn() {
        return getFullyQualifiedJavaType().equals(FullyQualifiedJavaType.getStringInstance());
    }

    public boolean isJdbcCharacterColumn() {
        return jdbcType == Types.CHAR || jdbcType == Types.CLOB
                || jdbcType == Types.LONGVARCHAR || jdbcType == Types.VARCHAR
                || jdbcType == Types.LONGNVARCHAR || jdbcType == Types.NCHAR
                || jdbcType == Types.NCLOB || jdbcType == Types.NVARCHAR;
    }

    public String getJavaProperty() {
        return getJavaProperty(null);
    }

    public String getJavaProperty(@Nullable String prefix) {
        String baseProperty = Objects.requireNonNull(javaProperty);
        if (prefix == null) {
            return baseProperty;
        }

        return prefix + baseProperty;
    }

    public void setJavaProperty(String javaProperty) {
        this.javaProperty = javaProperty;
    }

    public boolean isJDBCDateColumn() {
        return getFullyQualifiedJavaType().equals(FullyQualifiedJavaType.getDateInstance())
                && "DATE".equalsIgnoreCase(jdbcTypeName); //$NON-NLS-1$
    }

    public boolean isJDBCTimeColumn() {
        return getFullyQualifiedJavaType().equals(FullyQualifiedJavaType.getDateInstance())
                && "TIME".equalsIgnoreCase(jdbcTypeName); //$NON-NLS-1$
    }

    public Optional<String> getTypeHandler() {
        return Optional.ofNullable(typeHandler);
    }

    public void setTypeHandler(String typeHandler) {
        this.typeHandler = typeHandler;
    }

    public String getActualColumnName() {
        return Objects.requireNonNull(actualColumnName);
    }

    public void setColumnNameDelimited(boolean isColumnNameDelimited) {
        this.isColumnNameDelimited = isColumnNameDelimited;
    }

    public boolean isColumnNameDelimited() {
        return isColumnNameDelimited;
    }

    public String getJdbcTypeName() {
        return Objects.requireNonNullElse(jdbcTypeName, "OTHER");//$NON-NLS-1$
    }

    public void setJdbcTypeName(@Nullable String jdbcTypeName) {
        this.jdbcTypeName = jdbcTypeName;
    }

    public FullyQualifiedJavaType getFullyQualifiedJavaType() {
        return Objects.requireNonNull(fullyQualifiedJavaType);
    }

    public void setFullyQualifiedJavaType(FullyQualifiedJavaType fullyQualifiedJavaType) {
        this.fullyQualifiedJavaType = fullyQualifiedJavaType;
    }

    public Optional<String> getTableAlias() {
        return Optional.ofNullable(tableAlias);
    }

    public void setTableAlias(@Nullable String tableAlias) {
        this.tableAlias = tableAlias;
    }

    public Context getContext() {
        return Objects.requireNonNull(context);
    }

    public void setContext(Context context) {
        this.context = context;
    }

    public IntrospectedTable getIntrospectedTable() {
        return Objects.requireNonNull(introspectedTable);
    }

    public void setIntrospectedTable(IntrospectedTable introspectedTable) {
        this.introspectedTable = introspectedTable;
    }

    public Properties getProperties() {
        return properties;
    }

    public void setProperties(Properties properties) {
        this.properties.putAll(properties);
    }

    public Optional<String> getRemarks() {
        return Optional.ofNullable(remarks);
    }

    public void setRemarks(String remarks) {
        this.remarks = remarks;
    }

    public Optional<String> getDefaultValue() {
        return Optional.ofNullable(defaultValue);
    }

    public void setDefaultValue(@Nullable String defaultValue) {
        this.defaultValue = defaultValue;
    }

    public boolean isSequenceColumn() {
        return isSequenceColumn;
    }

    public void setSequenceColumn(boolean isSequenceColumn) {
        this.isSequenceColumn = isSequenceColumn;
    }

    public boolean isAutoIncrement() {
        return isAutoIncrement;
    }

    public void setAutoIncrement(boolean isAutoIncrement) {
        this.isAutoIncrement = isAutoIncrement;
    }

    public boolean isGeneratedColumn() {
        return isGeneratedColumn;
    }

    public void setGeneratedColumn(boolean isGeneratedColumn) {
        this.isGeneratedColumn = isGeneratedColumn;
    }

    public boolean isGeneratedAlways() {
        return isGeneratedAlways;
    }

    public void setGeneratedAlways(boolean isGeneratedAlways) {
        this.isGeneratedAlways = isGeneratedAlways;
    }

    /**
     * The platform specific type name as reported by the JDBC driver. This value is determined
     * from the DatabaseMetadata.getColumns() call - specifically ResultSet.getString("TYPE_NAME").
     * This value is platform dependent.
     *
     * @return the platform specific type name as reported by the JDBC driver
     */
    public String getActualTypeName() {
        return Objects.requireNonNull(actualTypeName);
    }

    public void setActualTypeName(String actualTypeName) {
        this.actualTypeName = actualTypeName;
    }
}

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.api;
17
18	import java.sql.Types;
19	import java.util.Objects;
20	import java.util.Optional;
21	import java.util.Properties;
22
23	import org.jspecify.annotations.Nullable;
24	import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
25	import org.mybatis.generator.config.Context;
26	import org.mybatis.generator.internal.util.StringUtility;
27
28	/**
29	* This class holds information about an introspected column.
30	*
31	* @author Jeff Butler
32	*/
33	public class IntrospectedColumn {
34	/**
35	* Only nullable because instances of this class are built through introspection. Not null in practice.
36	*/
37	protected @Nullable String actualColumnName;
38
39	protected int jdbcType;
40
41	/**
42	* The platform specific data type name as reported from DatabaseMetadata.getColumns().
43	*
44	* <p>Only nullable because instances of this class are built through introspection. Not null in practice.
45	*/
46	protected @Nullable String actualTypeName;
47
48	protected @Nullable String jdbcTypeName;
49
50	protected boolean nullable;
51
52	protected int length;
53
54	protected int scale;
55
56	protected boolean identity;
57
58	protected boolean isSequenceColumn;
59
60	/**
61	* Only nullable because instances of this class are built through introspection. Not null in practice.
62	*/
63	protected @Nullable String javaProperty;
64
65	/**
66	* Only nullable because instances of this class are built through introspection. Not null in practice.
67	*/
68	protected @Nullable FullyQualifiedJavaType fullyQualifiedJavaType;
69
70	protected @Nullable String tableAlias;
71
72	protected @Nullable String typeHandler;
73
74	/**
75	* Only nullable because instances of this class are built through introspection. Not null in practice.
76	*/
77	protected @Nullable Context context;
78
79	protected boolean isColumnNameDelimited;
80
81	/**
82	* Only nullable because instances of this class are built through introspection. Not null in practice.
83	*/
84	protected @Nullable IntrospectedTable introspectedTable;
85
86	protected final Properties properties;
87
88	// any database comment associated with this column. May be null
89	protected @Nullable String remarks;
90
91	protected @Nullable String defaultValue;
92
93	/**
94	* true if the JDBC driver reports that this column is auto-increment.
95	*/
96	protected boolean isAutoIncrement;
97
98	/**
99	* true if the JDBC driver reports that this column is generated.
100	*/
101	protected boolean isGeneratedColumn;
102
103	/**
104	* True if there is a column override that defines this column as GENERATED ALWAYS.
105	*/
106	protected boolean isGeneratedAlways;
107
108	/**
109	* Constructs a Column definition. This object holds all the information
110	* about a column that is required to generate Java objects and SQL maps;
111	*/
112	public IntrospectedColumn() {	1✔
113	properties = new Properties();	1✔
114	}	1✔
115
116	public int getJdbcType() {
117	return jdbcType;	1✔
118	}
119
120	public void setJdbcType(int jdbcType) {
121	this.jdbcType = jdbcType;	1✔
122	}	1✔
123
124	public int getLength() {
125	return length;	1✔
126	}
127
128	public void setLength(int length) {
129	this.length = length;	1✔
130	}	1✔
131
132	public boolean isNullable() {
133	return nullable;	×
134	}
135
136	public void setNullable(boolean nullable) {
137	this.nullable = nullable;	1✔
138	}	1✔
139
140	public int getScale() {
141	return scale;	1✔
142	}
143
144	public void setScale(int scale) {
145	this.scale = scale;	1✔
146	}	1✔
147
148	/*
149	* This method is primarily used for debugging, so we don't externalize the
150	* strings
151	*/
152	@Override
153	public String toString() {
154	return "Actual Column Name: " //$NON-NLS-1$	×
NEW 155	+ getActualColumnName()	×
156	+ ", JDBC Type: " //$NON-NLS-1$
157	+ jdbcType
158	+ ", Nullable: " //$NON-NLS-1$
159	+ nullable
160	+ ", Length: " //$NON-NLS-1$
161	+ length
162	+ ", Scale: " //$NON-NLS-1$
163	+ scale
164	+ ", Identity: " //$NON-NLS-1$
165	+ identity;
166	}
167
168	public void setActualColumnName(String actualColumnName) {
169	this.actualColumnName = actualColumnName;	1✔
170	isColumnNameDelimited = StringUtility.stringContainsSpace(actualColumnName);	1✔
171	}	1✔
172
173	public boolean isIdentity() {
174	return identity;	1✔
175	}
176
177	public void setIdentity(boolean identity) {
178	this.identity = identity;	1✔
179	}	1✔
180
181	public boolean isBLOBColumn() {
182	String typeName = getJdbcTypeName();	1✔
183
184	return "BINARY".equals(typeName) \|\| "BLOB".equals(typeName) //$NON-NLS-1$ //$NON-NLS-2$	1!
185	\|\| "CLOB".equals(typeName) \|\| "LONGNVARCHAR".equals(typeName) //$NON-NLS-1$ //$NON-NLS-2$	1!
186	\|\| "LONGVARBINARY".equals(typeName) \|\| "LONGVARCHAR".equals(typeName) //$NON-NLS-1$ //$NON-NLS-2$	1!
187	\|\| "NCLOB".equals(typeName) \|\| "VARBINARY".equals(typeName); //$NON-NLS-1$ //$NON-NLS-2$	1!
188	}
189
190	public boolean isStringColumn() {
191	return getFullyQualifiedJavaType().equals(FullyQualifiedJavaType.getStringInstance());	1✔
192	}
193
194	public boolean isJdbcCharacterColumn() {
195	return jdbcType == Types.CHAR \|\| jdbcType == Types.CLOB	1!
196	\|\| jdbcType == Types.LONGVARCHAR \|\| jdbcType == Types.VARCHAR
197	\|\| jdbcType == Types.LONGNVARCHAR \|\| jdbcType == Types.NCHAR
198	\|\| jdbcType == Types.NCLOB \|\| jdbcType == Types.NVARCHAR;
199	}
200
201	public String getJavaProperty() {
202	return getJavaProperty(null);	1✔
203	}
204
205	public String getJavaProperty(@Nullable String prefix) {
206	String baseProperty = Objects.requireNonNull(javaProperty);	1✔
207	if (prefix == null) {	1✔
208	return baseProperty;	1✔
209	}
210
211	return prefix + baseProperty;	1✔
212	}
213
214	public void setJavaProperty(String javaProperty) {
215	this.javaProperty = javaProperty;	1✔
216	}	1✔
217
218	public boolean isJDBCDateColumn() {
219	return getFullyQualifiedJavaType().equals(FullyQualifiedJavaType.getDateInstance())	1✔
220	&& "DATE".equalsIgnoreCase(jdbcTypeName); //$NON-NLS-1$	1✔
221	}
222
223	public boolean isJDBCTimeColumn() {
224	return getFullyQualifiedJavaType().equals(FullyQualifiedJavaType.getDateInstance())	1✔
225	&& "TIME".equalsIgnoreCase(jdbcTypeName); //$NON-NLS-1$	1✔
226	}
227
228	public Optional<String> getTypeHandler() {
229	return Optional.ofNullable(typeHandler);	1✔
230	}
231
232	public void setTypeHandler(String typeHandler) {
233	this.typeHandler = typeHandler;	1✔
234	}	1✔
235
236	public String getActualColumnName() {
237	return Objects.requireNonNull(actualColumnName);	1✔
238	}
239
240	public void setColumnNameDelimited(boolean isColumnNameDelimited) {
241	this.isColumnNameDelimited = isColumnNameDelimited;	1✔
242	}	1✔
243
244	public boolean isColumnNameDelimited() {
245	return isColumnNameDelimited;	1✔
246	}
247
248	public String getJdbcTypeName() {
249	return Objects.requireNonNullElse(jdbcTypeName, "OTHER");//$NON-NLS-1$	1✔
250	}
251
252	public void setJdbcTypeName(@Nullable String jdbcTypeName) {
253	this.jdbcTypeName = jdbcTypeName;	1✔
254	}	1✔
255
256	public FullyQualifiedJavaType getFullyQualifiedJavaType() {
257	return Objects.requireNonNull(fullyQualifiedJavaType);	1✔
258	}
259
260	public void setFullyQualifiedJavaType(FullyQualifiedJavaType fullyQualifiedJavaType) {
261	this.fullyQualifiedJavaType = fullyQualifiedJavaType;	1✔
262	}	1✔
263
264	public Optional<String> getTableAlias() {
265	return Optional.ofNullable(tableAlias);	1✔
266	}
267
268	public void setTableAlias(@Nullable String tableAlias) {
269	this.tableAlias = tableAlias;	1✔
270	}	1✔
271
272	public Context getContext() {
273	return Objects.requireNonNull(context);	1✔
274	}
275
276	public void setContext(Context context) {
277	this.context = context;	1✔
278	}	1✔
279
280	public IntrospectedTable getIntrospectedTable() {
281	return Objects.requireNonNull(introspectedTable);	1✔
282	}
283
284	public void setIntrospectedTable(IntrospectedTable introspectedTable) {
285	this.introspectedTable = introspectedTable;	1✔
286	}	1✔
287
288	public Properties getProperties() {
289	return properties;	1✔
290	}
291
292	public void setProperties(Properties properties) {
293	this.properties.putAll(properties);	1✔
294	}	1✔
295
296	public Optional<String> getRemarks() {
297	return Optional.ofNullable(remarks);	1✔
298	}
299
300	public void setRemarks(String remarks) {
301	this.remarks = remarks;	1✔
302	}	1✔
303
304	public Optional<String> getDefaultValue() {
NEW 305	return Optional.ofNullable(defaultValue);	×
306	}
307
308	public void setDefaultValue(@Nullable String defaultValue) {
309	this.defaultValue = defaultValue;	1✔
310	}	1✔
311
312	public boolean isSequenceColumn() {
313	return isSequenceColumn;	1✔
314	}
315
316	public void setSequenceColumn(boolean isSequenceColumn) {
317	this.isSequenceColumn = isSequenceColumn;	1✔
318	}	1✔
319
320	public boolean isAutoIncrement() {
321	return isAutoIncrement;	×
322	}
323
324	public void setAutoIncrement(boolean isAutoIncrement) {
325	this.isAutoIncrement = isAutoIncrement;	1✔
326	}	1✔
327
328	public boolean isGeneratedColumn() {
329	return isGeneratedColumn;	×
330	}
331
332	public void setGeneratedColumn(boolean isGeneratedColumn) {
333	this.isGeneratedColumn = isGeneratedColumn;	1✔
334	}	1✔
335
336	public boolean isGeneratedAlways() {
337	return isGeneratedAlways;	1✔
338	}
339
340	public void setGeneratedAlways(boolean isGeneratedAlways) {
341	this.isGeneratedAlways = isGeneratedAlways;	1✔
342	}	1✔
343
344	/**
345	* The platform specific type name as reported by the JDBC driver. This value is determined
346	* from the DatabaseMetadata.getColumns() call - specifically ResultSet.getString("TYPE_NAME").
347	* This value is platform dependent.
348	*
349	* @return the platform specific type name as reported by the JDBC driver
350	*/
351	public String getActualTypeName() {
NEW 352	return Objects.requireNonNull(actualTypeName);	×
353	}
354
355	public void setActualTypeName(String actualTypeName) {
356	this.actualTypeName = actualTypeName;	1✔
357	}	1✔
358	}

mybatis / generator / 1941

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

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