Package org.basinmc.plunger.mapping.csv

Class CSVParameterNameMappingParser.Builder

java.lang.Object

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

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

org.basinmc.plunger.mapping.csv.CSVParameterNameMappingParser.Builder

Enclosing class:

CSVParameterNameMappingParser

public static final class CSVParameterNameMappingParser.Builder
extends AbstractCSVMappingParser.MemberBuilder

Provides a factory for parameter name mapping parser instances.

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

Method Summary

Modifier and Type	Method	Description
CSVParameterNameMappingParser	build(String targetNameColumn)	Constructs a new CSV parameter name mapping parser based on the current builder configuration.
CSVParameterNameMappingParser.Builder	withClassNameColumn(String columnName)	Selects the column in which the enclosing class name will be found.
CSVParameterNameMappingParser.Builder	withFormat(org.apache.commons.csv.CSVFormat format)	Selects a CSV format to rely upon when parsing file or stream contents.
CSVParameterNameMappingParser.Builder	withMethodNameColumn(String columnName)	Selects the column in which the method name will be found.
CSVParameterNameMappingParser.Builder	withParameterIndexColumn(String columnName)	Selects the column in which the original parameter index will be found.
CSVParameterNameMappingParser.Builder	withParameterNameColumn(String columnName)	Selects the column in which the original parameter name will be found.
CSVParameterNameMappingParser.Builder	withSignatureColumn(String columnName)	Selects the column in which the ASM signature for the method will be found.

Methods inherited from class java.lang.Object

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

Method Detail

build

@NonNull
public CSVParameterNameMappingParser build(@NonNull
                                           String targetNameColumn)

Constructs a new CSV parameter name mapping parser based on the current builder configuration.

Parameters:

targetNameColumn - a target name column index.

Returns:

a name mapping parser.

Throws:

IllegalStateException - when neither parameterNameColumn or parameterIndexColumn are defined.

withClassNameColumn

@NonNull
public CSVParameterNameMappingParser.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 CSVParameterNameMappingParser.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.

withMethodNameColumn

@NonNull
public CSVParameterNameMappingParser.Builder withMethodNameColumn(@Nullable
                                                                  String columnName)

Selects the column in which the method 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 only evaluate whether or not the method name, class name and parameter name/index match (assuming that a class name and signature name index was configured).

Parameters:

columnName - a column index.

Returns:

a reference to this builder.

withParameterIndexColumn

@NonNull
public CSVParameterNameMappingParser.Builder withParameterIndexColumn(@Nullable
                                                                      String columnName)

Selects the column in which the original parameter index will be found.

Parameters:

columnName - a column index.

Returns:

a reference to this builder.

withParameterNameColumn

@NonNull
public CSVParameterNameMappingParser.Builder withParameterNameColumn(@Nullable
                                                                     String columnName)

Selects the column in which the original parameter name will be found.

Parameters:

columnName - a column index.

Returns:

a reference to this builder.

withSignatureColumn

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

Selects the column in which the ASM signature for the method 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 method name and class name match (assuming that a class name index was configured).

Parameters:

columnName - a column index.

Returns:

a reference to this builder.