Package com.opencsv.bean

Class BeanFieldSingleValue<T,I>

java.lang.Object

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

com.opencsv.bean.BeanFieldSingleValue<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>

Direct Known Subclasses:

BeanFieldJoin

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

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

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.regex.Pattern	capture	The regular expression to be used for capturing part of the input for processing.
protected java.lang.String	writeFormat	The format string used for packaging values to be written.

Fields inherited from class com.opencsv.bean.AbstractBeanField

converter, errorLocale, field, fieldAccess, required, type

Constructor Summary

Constructors

Constructor	Description
BeanFieldSingleValue(java.lang.Class<?> type, java.lang.reflect.Field field, boolean required, java.util.Locale errorLocale, CsvConverter converter, java.lang.String capture, java.lang.String format)	Simply calls the same constructor in the base class.

Method Summary

Modifier and Type	Method	Description
protected java.lang.Object	convert(java.lang.String value)	Passes the string to be converted to the converter.
protected java.lang.String	convertToWrite(java.lang.Object value)	Passes the object to be converted to the converter.

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

Field Detail

capture

protected final java.util.regex.Pattern capture

The regular expression to be used for capturing part of the input for processing. If there was no regular expression specified, this field is null.

writeFormat

protected final java.lang.String writeFormat

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

Constructor Detail

BeanFieldSingleValue

public BeanFieldSingleValue(java.lang.Class<?> type,
                            java.lang.reflect.Field field,
                            boolean required,
                            java.util.Locale errorLocale,
                            CsvConverter converter,
                            java.lang.String capture,
                            java.lang.String format)

Simply calls the same constructor in the base class.

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

capture - See CsvBindByName.capture()

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

See Also:

AbstractBeanField(Class, Field, boolean, Locale, CsvConverter)

Method Detail

convert

protected java.lang.Object convert(java.lang.String value)
                            throws CsvDataTypeMismatchException,
                                   CsvConstraintViolationException

Passes the string to be converted to the converter.

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:

CsvBadConverterException - If the converter is null

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

convertToWrite

protected java.lang.String convertToWrite(java.lang.Object value)
                                   throws CsvDataTypeMismatchException

Passes the object to be converted to 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:

CsvBadConverterException - If the converter is null

CsvDataTypeMismatchException - This implementation does not throw this exception

See Also:

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