com.landawn.abacus.util.EntityCodeConfig Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2021, Haiyang Li.
 *
 * 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
 *
 * http://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 com.landawn.abacus.util;

import java.lang.annotation.Annotation;
import java.util.Collection;
import java.util.List;

import com.landawn.abacus.annotation.Beta;
import com.landawn.abacus.annotation.Type.EnumBy;
import com.landawn.abacus.util.Tuple.Tuple2;
import com.landawn.abacus.util.Tuple.Tuple3;
import com.landawn.abacus.util.function.BiFunction;
import com.landawn.abacus.util.function.QuadFunction;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * A sample, just a sample, not a general configuration required.
 *  
 * EntityCodeConfig ecc = EntityCodeConfig.builder()
 *        .className("User")
 *        .packageName("codes.entity")
 *        .srcDir("./samples")
 *        .fieldNameConverter((tableName, columnName) -> StringUtil.toCamelCase(columnName))
 *        .fieldTypeConverter((tableName, columnName, fieldName, columnClassName) -> ClassUtil.getCanonicalClassName(ClassUtil.forClass(columnClassName)) // columnClassName <- resultSetMetaData.getColumnClassName(columnIndex);
 *                .replace("java.lang.", ""))
 *        .useBoxedType(false)
 *        .readOnlyFields(N.asSet("id"))
 *        .nonUpdatableFields(N.asSet("create_time"))
 *        // .idAnnotationClass(javax.persistence.Id.class)
 *        // .columnAnnotationClass(javax.persistence.Column.class)
 *        // .tableAnnotationClass(javax.persistence.Table.class)
 *        .customizedFields(N.asList(Tuple.of("columnName", "fieldName", java.util.Date.class)))
 *        .customizedFieldDbTypes(N.asList(Tuple.of("fieldName", "List")))
 *        .build();
 * 
 *
 */
@Builder
@Data
@NoArgsConstructor
@AllArgsConstructor
public final class EntityCodeConfig {

    private String className;
    private String packageName;
    private String srcDir;
    /**
     * First parameter in the function is table name, 2nd is column name.
     */
    private BiFunction fieldNameConverter;
    /**
     * First parameter in the function is table name, 2nd is column name, 3rd is field name, 4th is column class name.
     */
    private QuadFunction fieldTypeConverter;
    private List>> customizedFields;
    private List> customizedFieldDbTypes;

    private boolean useBoxedType;
    private boolean mapBigIntegerToLong;
    private boolean mapBigDecimalToDouble;

    private Collection readOnlyFields;
    private Collection nonUpdatableFields;
    private Collection idFields;
    private String idField;

    private Class tableAnnotationClass;
    private Class columnAnnotationClass;
    private Class idAnnotationClass;

    private boolean chainAccessor;
    private boolean generateBuilder;
    private boolean generateCopyMethod;

    // private List> customizedJsonFields;
    @Beta
    private JsonXmlConfig jsonXmlConfig;

    /**
     *  
     * @see com.landawn.abacus.annotation.JsonXmlConfig
     */
    @Builder
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public static class JsonXmlConfig {
        private NamingPolicy namingPolicy;

        private String ignoredFields;

        private String dateFormat;

        private String timeZone;

        private String numberFormat;

        private EnumBy enumerated;
    }
}