Package com.github.ngoanh2n.comparator

Class CsvComparisonOptions.Builder

java.lang.Object

com.github.ngoanh2n.comparator.CsvComparisonOptions.Builder

Enclosing interface:

CsvComparisonOptions

public static final class CsvComparisonOptions.Builder
extends Object

This class allows to build CsvComparisonOptions

Method Summary

Modifier and Type	Method	Description
CsvComparisonOptions	build()	Build CsvComparisonOptions based on CsvComparisonOptions.Builder
CsvComparisonOptions.Builder	selectColumnId(int index)	Set column index where has a data field unique
CsvComparisonOptions.Builder	selectColumnId(String name)	Set column name where has a data field unique
CsvComparisonOptions.Builder	selectColumns(Integer... indexes)	Select columns to compare (0-based)
CsvComparisonOptions.Builder	selectColumns(String... names)	Select columns to compare
CsvComparisonOptions.Builder	setEncoding(Charset encoding)	Set encoding to read and writing CSV files
CsvComparisonOptions.Builder	setLineSeparator(String lineSeparator)	Defines the line separator sequence that should be used for parsing and writing
CsvComparisonOptions.Builder	setResultOptions(CsvComparisonResultOptions options)	Set CsvComparisonResultOptions to adjust CsvComparisonResult output
CsvComparisonOptions.Builder	withoutHeaders()	This means, CSV files hasn't headers

Methods inherited from class java.lang.Object

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

Method Details

setEncoding

public CsvComparisonOptions.Builder setEncoding(@Nullable
 Charset encoding)

Set encoding to read and writing CSV files

Parameters:

encoding - is the Charset for reading and writing CSV files.
encoding

Returns:

CsvComparisonOptions.Builder

See Also:

• StandardCharsets

setLineSeparator

public CsvComparisonOptions.Builder setLineSeparator(@Nonnull
 String lineSeparator)

Defines the line separator sequence that should be used for parsing and writing

Parameters:

lineSeparator - is a sequence of 1 to 2 characters that identifies the end of a line

Returns:

CsvComparisonOptions.Builder

withoutHeaders

public CsvComparisonOptions.Builder withoutHeaders()

This means, CSV files hasn't headers

Returns:

CsvComparisonOptions.Builder

selectColumns

public CsvComparisonOptions.Builder selectColumns(@Nonnull
 String... names)

Select columns to compare

Parameters:

names - is the expected column names which assert or compare

Returns:

CsvComparisonOptions.Builder

selectColumns

public CsvComparisonOptions.Builder selectColumns(@Nonnull
 Integer... indexes)

Select columns to compare (0-based)

Parameters:

indexes - is the expected column indexes which assert or compare

Returns:

CsvComparisonOptions.Builder

selectColumnId

public CsvComparisonOptions.Builder selectColumnId(@Nonnull
 String name)

Set column name where has a data field unique

Parameters:

name - for indicating which is identity column name which data field is unique in a row.
You have to use selectColumns(String...) first.
e.g. #selectColumns("email", "firstname", "lastname")

Returns:

CsvComparisonOptions.Builder

selectColumnId

public CsvComparisonOptions.Builder selectColumnId(int index)

Set column index where has a data field unique

Parameters:

index - for indicating which is identity column index which data field is unique in a row.
You have to use selectColumns(Integer...) first.
e.g. #selectColumns(1, 2, 5)

Returns:

CsvComparisonOptions.Builder

setResultOptions

public CsvComparisonOptions.Builder setResultOptions(@Nonnull
 CsvComparisonResultOptions options)

Set CsvComparisonResultOptions to adjust CsvComparisonResult output

Parameters:

options - to adjust output

Returns:

CsvComparisonOptions.Builder

build

public CsvComparisonOptions build()

Build CsvComparisonOptions based on CsvComparisonOptions.Builder

Returns:

CsvComparisonOptions