com.poiji.option

Class PoijiOptions.PoijiOptionsBuilder

java.lang.Object

com.poiji.option.PoijiOptions.PoijiOptionsBuilder

Enclosing class:

PoijiOptions

public static class PoijiOptions.PoijiOptionsBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
PoijiOptions	build()
PoijiOptions.PoijiOptionsBuilder	dateLenient(boolean dateLenient) If the simple date format is lenient, use to set how strict the date formatting must be, defaults to lenient false.
PoijiOptions.PoijiOptionsBuilder	datePattern(String datePattern) set date pattern, default date format is "dd/M/yyyy" for java.util.Date
PoijiOptions.PoijiOptionsBuilder	dateRegex(String dateRegex) Date regex, if would like to specify a regex patter the date must be in, e.g.\\d{2}/\\d{1}/\\d{4}.
PoijiOptions.PoijiOptionsBuilder	dateTimeFormatter(DateTimeFormatter dateTimeFormatter) set a date time formatter, default date time formatter is "dd/M/yyyy" for java.time.LocalDate
PoijiOptions.PoijiOptionsBuilder	headerStart(int headerStart) This is to set the row which the unmarshall will use to start reading header titles, incase the header is not in row 0.
PoijiOptions.PoijiOptionsBuilder	ignoreHiddenSheets(boolean ignoreHiddenSheets) Ignore hidden sheets
PoijiOptions.PoijiOptionsBuilder	password(String password) set password for encrypted excel file, Default is null
PoijiOptions.PoijiOptionsBuilder	preferNullOverDefault(boolean preferNullOverDefault) set whether or not to use null instead of default values for Integer, Double, Float, Long, String and java.util.Date types.
static PoijiOptions.PoijiOptionsBuilder	settings()
static PoijiOptions.PoijiOptionsBuilder	settings(int skip) Skip a number of rows after the header row.
PoijiOptions.PoijiOptionsBuilder	sheetIndex(int sheetIndex) set sheet index, default is 0
PoijiOptions.PoijiOptionsBuilder	sheetName(String sheetName) Set The sheet Name
PoijiOptions.PoijiOptionsBuilder	skip(int skip) skip a number of rows after the header row.
PoijiOptions.PoijiOptionsBuilder	trimCellValue(boolean trimCellValue) Trim cell value
PoijiOptions.PoijiOptionsBuilder	withCasting(Casting casting) Use a custom casting implementation

Methods inherited from class java.lang.Object

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

Method Detail

settings

public static PoijiOptions.PoijiOptionsBuilder settings(int skip)

Skip a number of rows after the header row. The header row is not counted.

Parameters:

skip - ignored row number after the header row

Returns:

builder itself

settings

public static PoijiOptions.PoijiOptionsBuilder settings()

dateTimeFormatter

public PoijiOptions.PoijiOptionsBuilder dateTimeFormatter(DateTimeFormatter dateTimeFormatter)

set a date time formatter, default date time formatter is "dd/M/yyyy" for java.time.LocalDate

Parameters:

dateTimeFormatter - date time formatter

Returns:

this

datePattern

public PoijiOptions.PoijiOptionsBuilder datePattern(String datePattern)

set date pattern, default date format is "dd/M/yyyy" for java.util.Date

Parameters:

datePattern - date time formatter

Returns:

this

preferNullOverDefault

public PoijiOptions.PoijiOptionsBuilder preferNullOverDefault(boolean preferNullOverDefault)

set whether or not to use null instead of default values for Integer, Double, Float, Long, String and java.util.Date types.

Parameters:

preferNullOverDefault - boolean

Returns:

this

build

public PoijiOptions build()

sheetIndex

public PoijiOptions.PoijiOptionsBuilder sheetIndex(int sheetIndex)

set sheet index, default is 0

Parameters:

sheetIndex - number

Returns:

this

sheetName

public PoijiOptions.PoijiOptionsBuilder sheetName(String sheetName)

Set The sheet Name

Parameters:

sheetName -

Returns:

skip

public PoijiOptions.PoijiOptionsBuilder skip(int skip)

skip a number of rows after the header row. The header row is not counted.

Parameters:

skip - number

Returns:

this

password

public PoijiOptions.PoijiOptionsBuilder password(String password)

set password for encrypted excel file, Default is null

Parameters:

password -

Returns:

this

ignoreHiddenSheets

public PoijiOptions.PoijiOptionsBuilder ignoreHiddenSheets(boolean ignoreHiddenSheets)

Ignore hidden sheets

Parameters:

ignoreHiddenSheets - whether or not to ignore any hidden sheets in the work book.

Returns:

this

trimCellValue

public PoijiOptions.PoijiOptionsBuilder trimCellValue(boolean trimCellValue)

Trim cell value

Parameters:

trimCellValue - trim the cell value before processing work book.

Returns:

this

dateRegex

public PoijiOptions.PoijiOptionsBuilder dateRegex(String dateRegex)

Date regex, if would like to specify a regex patter the date must be in, e.g.\\d{2}/\\d{1}/\\d{4}.

Parameters:

dateRegex - date regex pattern

Returns:

this

dateLenient

public PoijiOptions.PoijiOptionsBuilder dateLenient(boolean dateLenient)

If the simple date format is lenient, use to set how strict the date formatting must be, defaults to lenient false. It works only for java.util.Date.

Parameters:

dateLenient - true or false

Returns:

this

withCasting

public PoijiOptions.PoijiOptionsBuilder withCasting(Casting casting)

Use a custom casting implementation

Parameters:

casting - custom casting implementation

Returns:

this

headerStart

public PoijiOptions.PoijiOptionsBuilder headerStart(int headerStart)

This is to set the row which the unmarshall will use to start reading header titles, incase the header is not in row 0.

Parameters:

headerStart - an index number of the excel header to start reading header

Returns:

this