Package org.basinmc.plunger.mapping.csv

Class CSVFieldNameMappingParser.Builder

java.lang.Object

org.basinmc.plunger.mapping.csv.AbstractCSVMappingParser.Builder

org.basinmc.plunger.mapping.csv.AbstractCSVMappingParser.MemberBuilder

org.basinmc.plunger.mapping.csv.CSVFieldNameMappingParser.Builder

Enclosing class:

CSVFieldNameMappingParser

public static class CSVFieldNameMappingParser.Builder
extends AbstractCSVMappingParser.MemberBuilder

Provides a factory for CSV backed field name mapping parsers.

Field Summary

Fields inherited from class org.basinmc.plunger.mapping.csv.AbstractCSVMappingParser.Builder

format

Fields inherited from class org.basinmc.plunger.mapping.csv.AbstractCSVMappingParser.MemberBuilder

classNameColumn

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CSVFieldNameMappingParser	build(String originalNameColumn, String targetNameColumn)	Constructs a new CSV field name mapping parser using the configuration within this builder.
CSVFieldNameMappingParser.Builder	withClassNameColumn(String columnName)	Selects the column in which the enclosing class name will be found.
CSVFieldNameMappingParser.Builder	withFormat(org.apache.commons.csv.CSVFormat format)	Selects a CSV format to rely upon when parsing file or stream contents.
CSVFieldNameMappingParser.Builder	withSignatureColumn(String columnName)	Selects the column in which the ASM signature for the field will be found.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

@NonNull
public CSVFieldNameMappingParser build(@NonNull
                                       String originalNameColumn,
                                       @NonNull
                                       String targetNameColumn)

Constructs a new CSV field name mapping parser using the configuration within this builder.

Parameters:

originalNameColumn - the name of the column in which the original field name is stored.

targetNameColumn - the name of the column in which the target field name is stored.

withClassNameColumn

@NonNull
public CSVFieldNameMappingParser.Builder withClassNameColumn(@Nullable
                                                             String columnName)

Selects the column in which the enclosing class name will be found.

If none is specified (e.g. this method is not called at all or null is passed), the resulting mapper will attempt to match a member based on any other configured factors).

Overrides:

withClassNameColumn in class AbstractCSVMappingParser.MemberBuilder

Parameters:

columnName - a column name.

Returns:

a reference to this builder.

withFormat

@NonNull
public CSVFieldNameMappingParser.Builder withFormat(@NonNull
                                                    org.apache.commons.csv.CSVFormat format)

Selects a CSV format to rely upon when parsing file or stream contents.

Overrides:

withFormat in class AbstractCSVMappingParser.Builder

Parameters:

format - a CSV format.

Returns:

a reference to this builder.

withSignatureColumn

@NonNull
public CSVFieldNameMappingParser.Builder withSignatureColumn(@Nullable
                                                             String columnName)

Selects the column in which the ASM signature for the field will be found.

If none is specified (e.g. this method is not called at all or null is passed), the resulting mapper will only evaluate whether or not the field name and class name match (assuming that a class name index was configured).

Parameters:

columnName - a column name.

Returns:

a reference to this builder.