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

This class converts an input to a date type.

This class should work with any type derived from java.util.Date as long as it has a constructor taking one long that specifies the number of milliseconds since the epoch. The following types are explicitly supported:

java.util.Date
java.sql.Date
java.sql.Time
java.sql.Timestamp

This class should work for any type that implements java.util.Calendar or is derived from javax.xml.datatype.XMLGregorianCalendar. The following types are explicitly supported:

Calendar (always a GregorianCalendar)
GregorianCalendar
XMLGregorianCalendar

It is also known to work with org.apache.xerces.jaxp.datatype.XMLGregorianCalendarImpl.

This class works for all types from the JDK that implement java.time.temporal.TemporalAccessor.

Field Summary

Modifier and Type	Field and Description
private static final String	CSVDATE_NOT_DATE
private final DateTimeFormatter	readDtf The formatter for all inputs to `java.time.temporal.TemporalAccessor` representations.
private final SimpleDateFormat	readSdf The formatter for all inputs to old-style date representations.
private final BiFunction<DateTimeFormatter, String, TemporalAccessor>	readTemporalConversionFunction A reference to the function to use when converting from strings to `java.time.temporal.TemporalAccessor`-based values.
private final DateTimeFormatter	writeDtf The formatter for all outputs from `java.time.temporal.TemporalAccessor` representations.
private final SimpleDateFormat	writeSdf The formatter for all outputs from old-style date representations.
private final BiFunction<DateTimeFormatter, TemporalAccessor, String>	writeTemporalConversionFunction A reference to the function to use when converting from `java.time.temporal.TemporalAccessor`-based values to strings.

Inherited from com.opencsv.bean.AbstractCsvConverter:: errorLocale locale type writeLocale

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	ConverterDate(Class<?> The type of the field being populated type, String If not null or empty, specifies the locale used for converting locale-specific data types locale, String If not null or empty, specifies the locale used for converting locale-specific data types for writing writeLocale, Locale The locale to use for error messages errorLocale, String The string to use for parsing the date. See `com.opencsv.bean.CsvDate#value()` readFormat, String The string to use for formatting the date. See `CsvDate#writeFormat()` writeFormat, String The `java.time.chrono.Chronology` to be used for reading if `java.time.temporal.TemporalAccessor`-based fields are in use readChronology, String The `java.time.chrono.Chronology` to be used for writing if `java.time.temporal.TemporalAccessor`-based fields are in use writeChronology) Initializes the class.

public

ConverterDate(Class<?>

The type of the field being populated

type, String

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

locale, String

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

writeLocale, Locale

The locale to use for error messages

errorLocale, String

The string to use for parsing the date. See com.opencsv.bean.CsvDate#value()

readFormat, String

The string to use for formatting the date. See CsvDate#writeFormat()

writeFormat, String

The java.time.chrono.Chronology to be used for reading if java.time.temporal.TemporalAccessor-based fields are in use

readChronology, String

The java.time.chrono.Chronology to be used for writing if java.time.temporal.TemporalAccessor-based fields are in use

writeChronology)

Initializes the class.

Method Summary

Modifier and Type	Method and Description
public Object	convertToRead(String value) Implements com.opencsv.bean.CsvConverter.convertToRead. Method for converting from a string to the proper data type of the destination field.
public String	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. convertToWrite(Object The object containing a date of one of the supported types value) Overrides com.opencsv.bean.AbstractCsvConverter.convertToWrite. Implements com.opencsv.bean.CsvConverter.convertToWrite. This method converts the encapsulated date type to a string, respecting any locales and conversion patterns that have been set through opencsv annotations.
private BiFunction<DateTimeFormatter, String, TemporalAccessor>	determineReadTemporalConversionFunction(Class<?> type)
private BiFunction<DateTimeFormatter, TemporalAccessor, String>	determineWriteTemporalConversionFunction(Class<?> type)
private Chronology	getChronology(String readChronology, Locale locale2)
private SimpleDateFormat	setDateFormat(String format, Locale formatLocale)
private DateTimeFormatter	setDateTimeFormatter(String format, Locale formatLocale)

Inherited from com.opencsv.bean.AbstractCsvConverter:: setErrorLocale setLocale setType setWriteLocale

Field Detail

CSVDATE_NOT_DATE	back to summary
private static final String CSVDATE_NOT_DATE

readDtf	back to summary
private final DateTimeFormatter readDtf The formatter for all inputs to `java.time.temporal.TemporalAccessor` representations.

readSdf	back to summary
private final SimpleDateFormat readSdf The formatter for all inputs to old-style date representations. It is absolutely critical that access to this member variable is always synchronized!

readTemporalConversionFunction	back to summary
private final BiFunction<DateTimeFormatter, String, TemporalAccessor> readTemporalConversionFunction A reference to the function to use when converting from strings to `java.time.temporal.TemporalAccessor`-based values.

writeDtf	back to summary
private final DateTimeFormatter writeDtf The formatter for all outputs from `java.time.temporal.TemporalAccessor` representations.

writeSdf	back to summary
private final SimpleDateFormat writeSdf The formatter for all outputs from old-style date representations. It is absolutely critical that access to this member variable is always synchronized!

writeTemporalConversionFunction	back to summary
private final BiFunction<DateTimeFormatter, TemporalAccessor, String> writeTemporalConversionFunction A reference to the function to use when converting from `java.time.temporal.TemporalAccessor`-based values to strings.

Constructor Detail

ConverterDate back to summary

ConverterDate	back to summary
public ConverterDate(Class<?> type, String locale, String writeLocale, Locale errorLocale, String readFormat, String writeFormat, String readChronology, String writeChronology) Initializes the class. This includes initializing the locales for reading and writing, the format strings for reading and writing, and the chronologies for reading and writing, all as necessary based on the type to be converted. Parameters type:Class<?> The type of the field being populated locale:String If not null or empty, specifies the locale used for converting locale-specific data types writeLocale:String If not null or empty, specifies the locale used for converting locale-specific data types for writing errorLocale:Locale The locale to use for error messages readFormat:String The string to use for parsing the date. See `com.opencsv.bean.CsvDate#value()` writeFormat:String The string to use for formatting the date. See `CsvDate#writeFormat()` readChronology:String The `java.time.chrono.Chronology` to be used for reading if `java.time.temporal.TemporalAccessor`-based fields are in use writeChronology:String The `java.time.chrono.Chronology` to be used for writing if `java.time.temporal.TemporalAccessor`-based fields are in use

public ConverterDate(Class<?> type, String locale, String writeLocale, Locale errorLocale, String readFormat, String writeFormat, String readChronology, String writeChronology)

Initializes the class. This includes initializing the locales for reading and writing, the format strings for reading and writing, and the chronologies for reading and writing, all as necessary based on the type to be converted.

Parameters

type:Class<?>: The type of the field being populated
locale:String: If not null or empty, specifies the locale used for converting locale-specific data types
writeLocale:String: If not null or empty, specifies the locale used for converting locale-specific data types for writing
errorLocale:Locale: The locale to use for error messages
readFormat:String: The string to use for parsing the date. See com.opencsv.bean.CsvDate#value()
writeFormat:String: The string to use for formatting the date. See CsvDate#writeFormat()
readChronology:String: The java.time.chrono.Chronology to be used for reading if java.time.temporal.TemporalAccessor-based fields are in use
writeChronology:String: The java.time.chrono.Chronology to be used for writing if java.time.temporal.TemporalAccessor-based fields are in use

Method Detail

convertToRead	back to summary
public Object convertToRead(String value) throws CsvDataTypeMismatchException Implements com.opencsv.bean.CsvConverter.convertToRead. Doc from com.opencsv.bean.CsvConverter.convertToRead. Method for converting from a string to the proper data type of the destination field. Annotations @Override Exceptions CsvDataTypeMismatchException: If the input string cannot be converted into the proper type

convertToRead

back to summary

public Object convertToRead(String value) throws CsvDataTypeMismatchException

Implements com.opencsv.bean.CsvConverter.convertToRead.

Doc from com.opencsv.bean.CsvConverter.convertToRead.

Method for converting from a string to the proper data type of the destination field.

Annotations

@Override

Exceptions

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

convertToWrite back to summary

convertToWrite	back to summary
public String convertToWrite(Object value) throws CsvDataTypeMismatchException Overrides com.opencsv.bean.AbstractCsvConverter.convertToWrite. Implements com.opencsv.bean.CsvConverter.convertToWrite. This method converts the encapsulated date type to a string, respecting any locales and conversion patterns that have been set through opencsv annotations. Parameters value:Object The object containing a date of one of the supported types Returns:String 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. Annotations @Override Exceptions CsvDataTypeMismatchException: If an unsupported type as been improperly annotated

public String convertToWrite(Object value) throws CsvDataTypeMismatchException

Overrides com.opencsv.bean.AbstractCsvConverter.convertToWrite.

Implements com.opencsv.bean.CsvConverter.convertToWrite.

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