Class BeanFieldSplit<T,I>

java.lang.Object

com.opencsv.bean.AbstractBeanField<T,I>

com.opencsv.bean.BeanFieldSplit<T,I>

Type Parameters:

T - The type of the bean being populated

I - Type of the index into a multivalued field

All Implemented Interfaces:

BeanField<T,I>

public class BeanFieldSplit<T,I>
extends AbstractBeanField<T,I>

This class concerns itself with handling collection-valued bean fields.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
private final Pattern	capture
private final Class<? extends Collection>	collectionType
private final Class<?>	elementType
private final Pattern	splitOn
private final String	writeDelimiter
private final String	writeFormat

Fields inherited from class AbstractBeanField

converter, errorLocale, field, fieldAccess, required, type

Constructor Summary

Constructors

Constructor	Description
BeanFieldSplit(Class<?> type, Field field, boolean required, Locale errorLocale, CsvConverter converter, String splitOn, String writeDelimiter, Class<? extends Collection> collectionType, Class<?> elementType, String capture, String format)	The only valid constructor.

Method Summary

Modifier and Type	Method	Description
protected Object	convert(String value)	This method manages the collection being created as well as splitting the data.
protected String	convertToWrite(Object value)	Manages converting a collection of values into a single string.
protected boolean	isFieldEmptyForWrite(Object value)	Checks that value is not null and not an empty Collection.

Methods inherited from class AbstractBeanField

assignValueToField, getErrorLocale, getField, getFieldValue, getType, indexAndSplitMultivaluedField, isRequired, setErrorLocale, setField, setFieldValue, setRequired, setType, write

Methods inherited from class Object

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

Field Details

splitOn

private final Pattern splitOn

capture

private final Pattern capture

writeDelimiter

private final String writeDelimiter

writeFormat

private final String writeFormat

collectionType

private final Class<? extends Collection> collectionType

elementType

private final Class<?> elementType

Constructor Details

BeanFieldSplit

public BeanFieldSplit(Class<?> type,
 Field field,
 boolean required,
 Locale errorLocale,
 CsvConverter converter,
 String splitOn,
 String writeDelimiter,
 Class<? extends Collection> collectionType,
 Class<?> elementType,
 String capture,
 String format)

The only valid constructor.

Parameters:

type - The type of the class in which this field is found. This is the type as instantiated by opencsv, and not necessarily the type in which the field is declared in the case of inheritance.

field - A Field object.

required - Whether or not this field is required in input

errorLocale - The errorLocale to use for error messages.

converter - The converter to be used to perform the actual data conversion

splitOn - See CsvBindAndSplitByName.splitOn()

writeDelimiter - See CsvBindAndSplitByName.writeDelimiter()

collectionType - See CsvBindAndSplitByName.collectionType()

elementType - See CsvBindAndSplitByName.elementType()

capture - See CsvBindAndSplitByName.capture()

format - The format string used for packaging values to be written. If null or empty, it is ignored.

Method Details

convert

protected Object convert(String value)
                  throws CsvDataTypeMismatchException,
CsvConstraintViolationException

This method manages the collection being created as well as splitting the data. Once the data are split, they are sent to the converter for the actual conversion.

Specified by:

convert in class AbstractBeanField<T,I>

Parameters:

value - The string from the selected field of the CSV file. If the field is marked as required in the annotation, this value is guaranteed not to be null, empty or blank according to StringUtils.isBlank(java.lang.CharSequence)

Returns:

An Object representing the input data converted into the proper type

Throws:

CsvDataTypeMismatchException - If the input string cannot be converted into the proper type

CsvConstraintViolationException - When the internal structure of data would be violated by the data in the CSV file

See Also:

• ConverterPrimitiveTypes.convertToRead(java.lang.String)
• ConverterDate.convertToRead(java.lang.String)
• ConverterNumber.convertToRead(String)

convertToWrite

protected String convertToWrite(Object value)
                         throws CsvDataTypeMismatchException

Manages converting a collection of values into a single string. The conversion of each individual value is performed by the converter.

Overrides:

convertToWrite in class AbstractBeanField<T,I>

Parameters:

value - The contents of the field currently being processed from the bean to be written. Can be null if the field is not marked as required.

Returns:

A string representation of the value of the field in question in the bean passed in, or an empty string if value is null

Throws:

CsvDataTypeMismatchException - This implementation does not throw this exception

See Also:

• AbstractBeanField.write(java.lang.Object, java.lang.Object)

isFieldEmptyForWrite

protected boolean isFieldEmptyForWrite(Object value)

Checks that value is not null and not an empty Collection.

Overrides:

isFieldEmptyForWrite in class AbstractBeanField<T,I>

Parameters:

value - The value of a field out of a bean that is being written to a CSV file. Can be null.

Returns:

Whether or not this implementation considers value to be empty for the purposes of its conversion