RecordWithMethodsPlugin.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.plugins;

import java.util.List;
import java.util.stream.Collectors;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.JavaVisibility;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.Parameter;
import org.mybatis.generator.api.dom.java.TopLevelRecord;
import org.mybatis.generator.internal.util.JavaBeansUtil;

public class RecordWithMethodsPlugin extends BaseRecordPlugin {

    public RecordWithMethodsPlugin() {
        super("skipRecordWithMethodsPlugin"); //$NON-NLS-1$
    }

    @Override
    protected void execute(TopLevelRecord topLevelRecord, IntrospectedTable introspectedTable) {
        List<IntrospectedColumn> allColumns = introspectedTable.getAllColumns();
        for (IntrospectedColumn column : allColumns) {
            Method withMethod = generateWithMethod(introspectedTable, column, allColumns);
            commentGenerator.addGeneralMethodAnnotation(withMethod, introspectedTable,
                    topLevelRecord.getImportedTypes());
            topLevelRecord.addMethod(withMethod);
        }
    }

    private Method generateWithMethod(IntrospectedTable table, IntrospectedColumn currentColumn,
                                      List<IntrospectedColumn> columns) {
        FullyQualifiedJavaType returnType = new FullyQualifiedJavaType(table.getBaseRecordType());
        String methodName = "with" //$NON-NLS-1$
                + JavaBeansUtil.uppercaseFirstLetterIfNecessary(currentColumn.getJavaProperty());
        Method method = new Method(methodName);
        method.setReturnType(returnType);
        method.setVisibility(JavaVisibility.PUBLIC);
        method.addParameter(new Parameter(currentColumn.getFullyQualifiedJavaType(), currentColumn.getJavaProperty()));
        method.addBodyLine(calculateReturnNewLine(columns, returnType));
        return method;
    }

    private String calculateReturnNewLine(List<IntrospectedColumn> columns, FullyQualifiedJavaType returnType) {
        String prefix = "return new " + returnType.getShortName() + "("; //$NON-NLS-1$ //$NON-NLS-2$
        return columns.stream()
                .map(IntrospectedColumn::getJavaProperty)
                .collect(Collectors.joining(", ", prefix, ");")); //$NON-NLS-1$ //$NON-NLS-2$

    }
}