org.aoju.bus.poi.excel

Class BookUtils

java.lang.Object

org.aoju.bus.poi.excel.BookUtils

public class BookUtils
extends Object

Excel工作簿Workbook相关工具类

Since:

JDK 1.8

Version:

3.1.9

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor and Description
BookUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.poi.ss.usermodel.Workbook	createBook(boolean isXlsx) 根据文件类型创建新的工作簿，文件路径
static org.apache.poi.ss.usermodel.Workbook	createBook(File excelFile) 创建或加载工作簿
static org.apache.poi.ss.usermodel.Workbook	createBook(File excelFile, String password) 创建或加载工作簿，只读模式
static org.apache.poi.ss.usermodel.Workbook	createBook(InputStream in, boolean closeAfterRead) 创建或加载工作簿
static org.apache.poi.ss.usermodel.Workbook	createBook(InputStream in, String password, boolean closeAfterRead) 创建或加载工作簿
static org.apache.poi.ss.usermodel.Workbook	createBook(String excelFilePath) 创建或加载工作簿
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook() 创建SXSSFWorkbook，用于大批量数据写出
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(File excelFile) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(File excelFile, String password) 创建或加载SXSSFWorkbook工作簿，只读模式
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(InputStream in, boolean closeAfterRead) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(InputStream in, String password, boolean closeAfterRead) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(int rowAccessWindowSize) 创建SXSSFWorkbook，用于大批量数据写出
static org.apache.poi.xssf.streaming.SXSSFWorkbook	createSXSSFBook(String excelFilePath) 创建或加载SXSSFWorkbook工作簿
static org.apache.poi.ss.usermodel.Sheet	getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book, String sheetName) 获取或者创建sheet表 如果sheet表在Workbook中已经存在，则获取之，否则创建之
static boolean	isEmpty(org.apache.poi.ss.usermodel.Sheet sheet) sheet是否为空
static void	writeBook(org.apache.poi.ss.usermodel.Workbook book, OutputStream out) 将Excel Workbook刷出到输出流，不关闭流

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookUtils

public BookUtils()

Method Detail

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(String excelFilePath)

创建或加载工作簿

Parameters:

excelFilePath - Excel文件路径，绝对路径或相对于ClassPath路径

Returns:

Workbook

Since:

3.1.1

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(File excelFile)

创建或加载工作簿

Parameters:

excelFile - Excel文件

Returns:

Workbook

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(File excelFile,
                                                              String password)

创建或加载工作簿，只读模式

Parameters:

excelFile - Excel文件

password - Excel工作簿密码，如果无密码传null

Returns:

Workbook

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(InputStream in,
                                                              boolean closeAfterRead)

创建或加载工作簿

Parameters:

in - Excel输入流

closeAfterRead - 读取结束是否关闭流

Returns:

Workbook

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(InputStream in,
                                                              String password,
                                                              boolean closeAfterRead)

创建或加载工作簿

Parameters:

in - Excel输入流

password - 密码

closeAfterRead - 读取结束是否关闭流

Returns:

Workbook

Since:

4.0.3

createBook

public static org.apache.poi.ss.usermodel.Workbook createBook(boolean isXlsx)

根据文件类型创建新的工作簿，文件路径

Parameters:

isXlsx - 是否为xlsx格式的Excel

Returns:

Workbook

Since:

4.1.0

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(String excelFilePath)

创建或加载SXSSFWorkbook工作簿

Parameters:

excelFilePath - Excel文件路径，绝对路径或相对于ClassPath路径

Returns:

SXSSFWorkbook

Since:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(File excelFile)

创建或加载SXSSFWorkbook工作簿

Parameters:

excelFile - Excel文件

Returns:

SXSSFWorkbook

Since:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(File excelFile,
                                                                          String password)

创建或加载SXSSFWorkbook工作簿，只读模式

Parameters:

excelFile - Excel文件

password - Excel工作簿密码，如果无密码传null

Returns:

SXSSFWorkbook

Since:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(InputStream in,
                                                                          boolean closeAfterRead)

创建或加载SXSSFWorkbook工作簿

Parameters:

in - Excel输入流

closeAfterRead - 读取结束是否关闭流

Returns:

SXSSFWorkbook

Since:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(InputStream in,
                                                                          String password,
                                                                          boolean closeAfterRead)

创建或加载SXSSFWorkbook工作簿

Parameters:

in - Excel输入流

password - 密码

closeAfterRead - 读取结束是否关闭流

Returns:

SXSSFWorkbook

Since:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook()

创建SXSSFWorkbook，用于大批量数据写出

Returns:

SXSSFWorkbook

Since:

4.1.13

createSXSSFBook

public static org.apache.poi.xssf.streaming.SXSSFWorkbook createSXSSFBook(int rowAccessWindowSize)

创建SXSSFWorkbook，用于大批量数据写出

Parameters:

rowAccessWindowSize - 在内存中的行数

Returns:

Workbook

Since:

4.1.13

writeBook

public static void writeBook(org.apache.poi.ss.usermodel.Workbook book,
                             OutputStream out)
                      throws org.aoju.bus.core.lang.exception.InstrumentException

将Excel Workbook刷出到输出流，不关闭流

Parameters:

book - Workbook

out - 输出流

Throws:

org.aoju.bus.core.lang.exception.InstrumentException - IO异常

Since:

3.2.0

getOrCreateSheet

public static org.apache.poi.ss.usermodel.Sheet getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book,
                                                                 String sheetName)

获取或者创建sheet表 如果sheet表在Workbook中已经存在，则获取之，否则创建之

Parameters:

book - 工作簿Workbook

sheetName - 工作表名

Returns:

工作表Sheet

Since:

4.0.2

isEmpty

public static boolean isEmpty(org.apache.poi.ss.usermodel.Sheet sheet)

sheet是否为空

Parameters:

sheet - Sheet

Returns:

sheet是否为空

Since:

4.0.1