Package com.github.ngoanh2n.csv
Interface CsvComparisonVisitor
- All Known Implementing Classes:
CsvComparisonOutput
public interface CsvComparisonVisitor
This interface should be used to walk through CsvComparator.
How to build the service provider:
How to build the service provider:
- 1. Create a class that implements SPI CsvComparisonVisitor
package com.company.project.impl; import com.github.ngoanh2n.csv.CsvComparisonVisitor; public class MyComparisonVisitor implements CsvComparisonVisitor { // // IMPLEMENTED METHODS // }
- 2. Create a provider configuration file:
- Location:
resources/META-INF/services
- Name:
com.github.ngoanh2n.csv.CsvComparisonVisitor
- Content:
com.company.project.impl.MyComparisonVisitor
- Location:
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
comparisonFinished
(CsvComparisonOptions options, CsvComparisonSource source, CsvComparisonResult result) Callback after CsvComparator.compare(CsvComparisonSource, CsvComparisonOptions).default void
comparisonStarted
(CsvComparisonOptions options, CsvComparisonSource source) Callback before CsvComparator.compare(CsvComparisonSource, CsvComparisonOptions).default void
rowDeleted
(CsvComparisonOptions options, String[] headers, String[] row) Callback for when CsvComparator detected a row deleted.default void
rowInserted
(CsvComparisonOptions options, String[] headers, String[] row) Callback for when CsvComparator detected a row inserted.default void
rowKept
(CsvComparisonOptions options, String[] headers, String[] row) Callback for when CsvComparator detected a row kept.default void
rowModified
(CsvComparisonOptions options, String[] headers, String[] row, List<HashMap<String, String>> diffs) Callback for when CsvComparator detected a row modified.
-
Method Details
-
comparisonStarted
Callback before CsvComparator.compare(CsvComparisonSource, CsvComparisonOptions).- Parameters:
source
- CsvComparisonSource is being to compare.options
- CsvComparisonOptions you have provided.
-
rowKept
Callback for when CsvComparator detected a row kept.- Parameters:
row
- The row kept.headers
- Extracted from CsvComparisonSource you have provided.
Headers row is existed or not depends on CsvComparisonOptions.Builder.withoutHeaders().options
- CsvComparisonOptions you have provided.
-
rowDeleted
Callback for when CsvComparator detected a row deleted.- Parameters:
row
- The row deleted.headers
- Extracted from CsvComparisonSource you have provided.
Headers row is existed or not depends on CsvComparisonOptions.Builder.withoutHeaders().options
- CsvComparisonOptions you have provided.
-
rowInserted
Callback for when CsvComparator detected a row inserted.- Parameters:
row
- The row inserted.headers
- Extracted from CsvComparisonSource you have provided.
Headers row is existed or not depends on CsvComparisonOptions.Builder.withoutHeaders().options
- CsvComparisonOptions you have provided.
-
rowModified
default void rowModified(CsvComparisonOptions options, String[] headers, String[] row, List<HashMap<String, String>> diffs) Callback for when CsvComparator detected a row modified.- Parameters:
row
- The row modified.headers
- Extracted from CsvComparisonSource you have provided.
Headers row is existed or not depends on CsvComparisonOptions.Builder.withoutHeaders() (boolean)}.options
- CsvComparisonOptions you have provided.diffs
- List of difference at specific cells: [column, expCell, actCell]
- column: name of column (header)
- expCell: cell value of expected CSV
- actCell: cell value of actual CSV
-
comparisonFinished
default void comparisonFinished(CsvComparisonOptions options, CsvComparisonSource source, CsvComparisonResult result) Callback after CsvComparator.compare(CsvComparisonSource, CsvComparisonOptions).- Parameters:
source
- CsvComparisonSource is being to compare.options
- CsvComparisonOptions you have provided.result
- CsvComparisonResult after comparison process ended.
-