com.opencsv.bean

Class BeanFieldDate<T>

java.lang.Object

com.opencsv.bean.AbstractBeanField<T>

com.opencsv.bean.BeanFieldDate<T>

Type Parameters:

T - Type of the bean to be manipulated

All Implemented Interfaces:

BeanField<T>

public class BeanFieldDate<T>
extends AbstractBeanField<T>

This class converts an input to a date type. I would dearly love to use Apache Commons BeanUtils to make this class smaller and easier, but BeanUtils is abysmal with dates of all types.

Since:

3.8

Author:

Andrew Rucker Jones

See Also:

CsvDate

Field Summary

Fields inherited from class com.opencsv.bean.AbstractBeanField

errorLocale, field, required

Constructor Summary

Constructors

Constructor and Description
BeanFieldDate(Field field, boolean required, String formatString, String locale, Locale errorLocale)

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	convert(String value) Method for converting from a string to the proper datatype of the destination field.
protected String	convertToWrite(Object value) This method converts the encapsulated date type to a string, respecting any locales and conversion patterns that have been set through opencsv annotations.

Methods inherited from class com.opencsv.bean.AbstractBeanField

getField, isRequired, setErrorLocale, setField, setFieldValue, setRequired, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanFieldDate

public BeanFieldDate(Field field,
             boolean required,
             String formatString,
             String locale,
             Locale errorLocale)

Parameters:

field - A Field object.

required - True if the field is required to contain a value, false if it is allowed to be null or a blank string.

formatString - The string to use for formatting the date. See CsvDate.value()

locale - If not null or empty, specifies the locale used for converting locale-specific data types

errorLocale - The locale to use for error messages.

Method Detail

convert

protected Object convert(String value)
                  throws CsvDataTypeMismatchException

Description copied from class: AbstractBeanField

Method for converting from a string to the proper datatype of the destination field. This method must be specified in all non-abstract derived classes.

Specified by:

convert in class AbstractBeanField<T>

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

convertToWrite

protected String convertToWrite(Object value)
                         throws CsvDataTypeMismatchException

This method converts the encapsulated date type to a string, respecting any locales and conversion patterns that have been set through opencsv annotations.

Overrides:

convertToWrite in class AbstractBeanField<T>

Parameters:

value - The object containing a date of one of the supported types

Returns:

A string representation of the date. If a locale or conversion pattern has been specified through annotations, these are used when creating the return value.

Throws:

CsvDataTypeMismatchException - If an unsupported type as been improperly annotated

See Also:

AbstractBeanField.write(java.lang.Object)