Class StringArrayHandler

java.lang.Object

de.siegmar.fastcsv.reader.CsvCallbackHandler<String[]>

de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler<String[]>

de.siegmar.fastcsv.reader.StringArrayHandler

public final class StringArrayHandler
extends AbstractInternalCsvCallbackHandler<String[]>

A CsvCallbackHandler implementation that returns the fields of each record as an array of Strings.

Example:

StringArrayHandler handler = StringArrayHandler.builder()
    .fieldModifier(FieldModifiers.TRIM)
    .build();

This implementation is stateful and must not be reused.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StringArrayHandler.StringArrayHandlerBuilder	A builder for StringArrayHandler.

Nested classes/interfaces inherited from class de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler

AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<T extends AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<?>>

Field Summary

Fields inherited from class de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler

comment, emptyLine, fieldIdx, fieldModifier, fields, maxFields, maxFieldSize, maxRecordSize, recordSize, startingLineNumber

Constructor Summary

Constructors

Constructor	Description
StringArrayHandler()	Deprecated, for removal: This API element is subject to removal in a future version. Use of() instead.
StringArrayHandler(FieldModifier fieldModifier)	Deprecated, for removal: This API element is subject to removal in a future version. Use builder() or of(Consumer) instead.

Method Summary

Modifier and Type	Method	Description
static StringArrayHandler.StringArrayHandlerBuilder	builder()	Constructs a new builder instance for this class.
protected RecordWrapper<String[]>	buildRecord()	Called at the end of each CSV record to build an object representation of the record.
static StringArrayHandler	of()	Constructs a new instance of this class with default settings.
static StringArrayHandler	of(Consumer<StringArrayHandler.StringArrayHandlerBuilder> configurer)	Constructs a new instance of this class with the given configuration.

Methods inherited from class de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler

addField, beginRecord, buildWrapper, compactFields, modifyComment, modifyField, setComment

Methods inherited from class de.siegmar.fastcsv.reader.CsvCallbackHandler

terminate

Methods inherited from class java.lang.Object

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

Constructor Details

StringArrayHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public StringArrayHandler()

Deprecated, for removal: This API element is subject to removal in a future version.

Use of() instead.

Constructs a new StringArrayHandler.

StringArrayHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public StringArrayHandler(FieldModifier fieldModifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Use builder() or of(Consumer) instead.

Constructs a new StringArrayHandler with the given field modifier.

Parameters:

fieldModifier - the field modifier, must not be null

Throws:

NullPointerException - if null is passed

Method Details

builder

public static StringArrayHandler.StringArrayHandlerBuilder builder()

Constructs a new builder instance for this class.

Returns:

the builder

See Also:

• of(Consumer)

of

public static StringArrayHandler of()

Constructs a new instance of this class with default settings.

Returns:

the new instance

See Also:

• StringArrayHandler.StringArrayHandlerBuilder.build()

of

public static StringArrayHandler of(Consumer<StringArrayHandler.StringArrayHandlerBuilder> configurer)

Constructs a new instance of this class with the given configuration.

This is an alternative to the builder pattern for convenience.

Parameters:

configurer - the configuration, must not be null

Returns:

the new instance

Throws:

NullPointerException - if null is passed

IllegalArgumentException - if argument constraints are violated

See Also:

• builder()

buildRecord

protected RecordWrapper<String[]> buildRecord()

Description copied from class: CsvCallbackHandler

Called at the end of each CSV record to build an object representation of the record.

The returned wrapper is used by the CsvReader in order to determine how to process the record.

Specified by:

buildRecord in class CsvCallbackHandler<String[]>

Returns:

the record wrapper or null if the record should be ignored/skipped