com.github.houbb.csv.api.IWriteContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of csv Show documentation

The csv read/write tool based on java annotation.

There is a newer version: 0.2.0

package com.github.houbb.csv.api;

import com.github.houbb.heaven.support.sort.ISort;

import java.util.List;

/**
 * 写入上下文
 * @author binbin.hou
 * @since 0.0.1
 * @param  泛型
 */
public interface IWriteContext {

    /**
     * 是否写入 bom
     * @return 是否写入 bom
     */
    boolean writeBom();

    /**
     * 是否写入标题头
     * @return 是否写入 head 行
     */
    boolean writeHead();

    /**
     * 文件编码
     * @return 文件编码
     */
    String charset();

    /**
     * 排序方式
     * @return 排序方式
     */
    ISort sort();

    /**
     * 文件路径
     * @return 文件路径
     */
    String path();

    /**
     * 待写入的列表
     * @return 待写入的列表
     */
    List list();

}