io.mybatis.provider.EntityColumnFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mybatis-provider Show documentation

MyBatis Provider 扩展

The newest version!

/*
 * Copyright 2020-2022 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
 *
 *    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 io.mybatis.provider;

import java.util.Collections;
import java.util.List;
import java.util.Optional;

/**
 * 实体类信息工厂，可以通过 SPI 加入处理链
 *
 * @author liuzh
 */
public interface EntityColumnFactory extends Order {
  /**
   * 忽略字段
   */
  Optional> IGNORE = Optional.of(Collections.emptyList());

  /**
   * 创建列信息，一个字段可能不是列，也可能是列，还有可能对应多个列（例如 ValueObject对象）
   *
   * @param entityTable
   * @param field       字段信息
   * @param chain       调用下一个
   * @return 实体类中列的信息，如果返回空，则不属于实体中的列
   */
  Optional> createEntityColumn(EntityTable entityTable, EntityField field, Chain chain);

  /**
   * 工厂链
   */
  interface Chain {
    /**
     * 创建列信息，一个字段可能不是列，也可能是列，还有可能对应多个列（例如 ValueObject对象）
     *
     * @param entityTable
     * @param field       字段信息
     * @return 实体类中列的信息，如果返回空，则不属于实体中的列
     */
    Optional> createEntityColumn(EntityTable entityTable, EntityField field);
  }

}