com.opencsv.bean.customconverter

Class ConvertSplitOnWhitespace<T,I>

java.lang.Object

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

com.opencsv.bean.customconverter.ConvertSplitOnWhitespace<T,I>

Type Parameters:

T - Type of the bean to be manipulated

I - Type of the index into a multivalued field

All Implemented Interfaces:

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

public class ConvertSplitOnWhitespace<T,I>
extends com.opencsv.bean.AbstractBeanField<T,I>

This class takes a string and splits it on whitespace into a list of strings.

Author:

Andrew Rucker Jones

Field Summary

Fields inherited from class com.opencsv.bean.AbstractBeanField

converter, errorLocale, field, fieldAccess, required, type

Constructor Summary

Constructors

Constructor and Description
ConvertSplitOnWhitespace() Silence code style checker by adding a useless constructor.

Method Summary

Modifier and Type	Method and Description
protected Object	convert(String value) Takes a string that is a list of substrings separated by whitespace and returns a list of the substrings.
protected String	convertToWrite(Object value) This method takes the current value of the field in question in the bean passed in and converts it to a string.

Methods inherited from class com.opencsv.bean.AbstractBeanField

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertSplitOnWhitespace

public ConvertSplitOnWhitespace()

Silence code style checker by adding a useless constructor.

Method Detail

convert

protected Object convert(String value)

Takes a string that is a list of substrings separated by whitespace and returns a list of the substrings. For example, the string "Jones Smith Cartwright Cooper" would be converted by this method to ("Jones", "Smith", "Cartwright", "Cooper"). When might this be useful? A CSV has a set number of columns, but sometimes some fields might need to contain a variable number of entries. In this case, a list within one field of a CSV might make sense.

Specified by:

convert in class com.opencsv.bean.AbstractBeanField<T,I>

Parameters:

value - The string to be converted

Returns:

List<String> consisting of the substrings from the input that were separated in the input by whitespace

convertToWrite

protected String convertToWrite(Object value)
                         throws com.opencsv.exceptions.CsvDataTypeMismatchException

This method takes the current value of the field in question in the bean passed in and converts it to a string.

Overrides:

convertToWrite in class com.opencsv.bean.AbstractBeanField<T,I>

Returns:

The concatenation of a list of strings, with every entry separated by a space

Throws:

com.opencsv.exceptions.CsvDataTypeMismatchException - If the field is not a list of strings