opencsv 5.12.0 · com.opencsv.bean.BeanFieldSplit · APIdia, the JavaDoc alternative

Field Summary

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

Inherited from com.opencsv.bean.AbstractBeanField:: converter errorLocale field fieldAccess required type

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	BeanFieldSplit(Class<?> 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. type, Field A `java.lang.reflect.Field` object. field, boolean Whether or not this field is required in input required, Locale The errorLocale to use for error messages. errorLocale, CsvConverter The converter to be used to perform the actual data conversion converter, String See `CsvBindAndSplitByName#splitOn()` splitOn, String See `CsvBindAndSplitByName#writeDelimiter()` writeDelimiter, Class<? extends Collection<E>> See `CsvBindAndSplitByName#collectionType()` collectionType, Class<?> See `CsvBindAndSplitByName#elementType()` elementType, String See `CsvBindAndSplitByName#capture()` capture, String The format string used for packaging values to be written. If `null` or empty, it is ignored. format) The only valid constructor.

public

BeanFieldSplit(Class<?>

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.

type, Field

A java.lang.reflect.Field object.

field, boolean

Whether or not this field is required in input

required, Locale

The errorLocale to use for error messages.

errorLocale, CsvConverter

The converter to be used to perform the actual data conversion

converter, String

See CsvBindAndSplitByName#splitOn()

splitOn, String

See CsvBindAndSplitByName#writeDelimiter()

writeDelimiter, Class<? extends Collection<E>>

See CsvBindAndSplitByName#collectionType()

collectionType, Class<?>

See CsvBindAndSplitByName#elementType()

elementType, String

See CsvBindAndSplitByName#capture()

capture, String

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

format)

The only valid constructor.

Method Summary

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

Inherited from com.opencsv.bean.AbstractBeanField:: assignValueToField getErrorLocale getField getFieldValue getType indexAndSplitMultivaluedField isRequired setErrorLocale setField setFieldValue setRequired setType write

Field Detail

capture	back to summary
private final Pattern capture

collectionType	back to summary
private final Class<? extends Collection<E>> collectionType

elementType	back to summary
private final Class<?> elementType

splitOn	back to summary
private final Pattern splitOn

writeDelimiter	back to summary
private final String writeDelimiter

writeFormat	back to summary
private final String writeFormat

Constructor Detail

BeanFieldSplit back to summary

BeanFieldSplit	back to summary
public BeanFieldSplit(Class<?> type, Field field, boolean required, Locale errorLocale, CsvConverter converter, String splitOn, String writeDelimiter, Class<? extends Collection<E>> collectionType, Class<?> elementType, String capture, String format) The only valid constructor. Parameters type:Class<?> 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:Field A `java.lang.reflect.Field` object. required:boolean Whether or not this field is required in input errorLocale:Locale The errorLocale to use for error messages. converter:CsvConverter The converter to be used to perform the actual data conversion splitOn:String See `CsvBindAndSplitByName#splitOn()` writeDelimiter:String See `CsvBindAndSplitByName#writeDelimiter()` collectionType:Class<? extends Collection<E>> See `CsvBindAndSplitByName#collectionType()` elementType:Class<?> See `CsvBindAndSplitByName#elementType()` capture:String See `CsvBindAndSplitByName#capture()` format:String The format string used for packaging values to be written. If `null` or empty, it is ignored.

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

The only valid constructor.

Parameters

type:Class<?>: 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:Field: A java.lang.reflect.Field object.
required:boolean: Whether or not this field is required in input
errorLocale:Locale: The errorLocale to use for error messages.
converter:CsvConverter: The converter to be used to perform the actual data conversion
splitOn:String: See CsvBindAndSplitByName#splitOn()
writeDelimiter:String: See CsvBindAndSplitByName#writeDelimiter()
collectionType:Class<? extends Collection<E>>: See CsvBindAndSplitByName#collectionType()
elementType:Class<?>: See CsvBindAndSplitByName#elementType()
capture:String: See CsvBindAndSplitByName#capture()
format:String: The format string used for packaging values to be written. If null or empty, it is ignored.

Method Detail

convert back to summary

convert	back to summary
protected Object convert(String value) throws CsvDataTypeMismatchException, CsvConstraintViolationException Implements abstract com.opencsv.bean.AbstractBeanField.convert. 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. Annotations @Override Exceptions CsvDataTypeMismatchException: Doc from com.opencsv.bean.AbstractBeanField.convert. If the input string cannot be converted into the proper type CsvConstraintViolationException: Doc from com.opencsv.bean.AbstractBeanField.convert. 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)`

protected Object convert(String value) throws CsvDataTypeMismatchException, CsvConstraintViolationException

Implements abstract com.opencsv.bean.AbstractBeanField.convert.

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.

Annotations

@Override

Exceptions

CsvDataTypeMismatchException:

Doc from com.opencsv.bean.AbstractBeanField.convert.

If the input string cannot be converted into the proper type

CsvConstraintViolationException:

Doc from com.opencsv.bean.AbstractBeanField.convert.

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

convertToWrite	back to summary
protected String convertToWrite(Object value) throws CsvDataTypeMismatchException Overrides com.opencsv.bean.AbstractBeanField.convertToWrite. Manages converting a collection of values into a single string. The conversion of each individual value is performed by the converter. Annotations @Override Exceptions CsvDataTypeMismatchException: Doc from com.opencsv.bean.AbstractBeanField.convertToWrite. This implementation does not throw this exception

convertToWrite

back to summary

protected String convertToWrite(Object value) throws CsvDataTypeMismatchException

Overrides com.opencsv.bean.AbstractBeanField.convertToWrite.

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

Annotations

@Override

Exceptions

CsvDataTypeMismatchException:

Doc from com.opencsv.bean.AbstractBeanField.convertToWrite.

This implementation does not throw this exception

isFieldEmptyForWrite back to summary

isFieldEmptyForWrite	back to summary
protected boolean isFieldEmptyForWrite(Object value) Overrides com.opencsv.bean.AbstractBeanField.isFieldEmptyForWrite. Checks that `value` is not null and not an empty `java.util.Collection`. Annotations @SuppressWarnings:unchecked @Override

protected boolean isFieldEmptyForWrite(Object value)

Overrides com.opencsv.bean.AbstractBeanField.isFieldEmptyForWrite.

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

Annotations

@SuppressWarnings:unchecked
@Override

public Class BeanFieldSplit<T, I>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail