Package com.opencsv.bean

Class ConverterDate

  • All Implemented Interfaces:
    CsvConverter
    public class ConverterDate
extends AbstractCsvConverter
    This class converts an input to a date type.

    This class should work with any type derived from 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 Calendar or is derived from 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 TemporalAccessor.

    Since:
    4.2 (previously BeanFieldDate since 3.8)
    See Also:
    CsvDate

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      ConverterDate​(java.lang.Class<?> type, java.lang.String locale, java.lang.String writeLocale, java.util.Locale errorLocale, java.lang.String readFormat, java.lang.String writeFormat, java.lang.String readChronology, java.lang.String writeChronology)
      Initializes the class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object convertToRead​(java.lang.String value)
      Method for converting from a string to the proper data type of the destination field.
      java.lang.String convertToWrite​(java.lang.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.
      private java.util.function.BiFunction<java.time.format.DateTimeFormatter,​java.lang.String,​java.time.temporal.TemporalAccessor> determineReadTemporalConversionFunction​(java.lang.Class<?> type)  
      private java.util.function.BiFunction<java.time.format.DateTimeFormatter,​java.time.temporal.TemporalAccessor,​java.lang.String> determineWriteTemporalConversionFunction​(java.lang.Class<?> type)  
      private java.time.chrono.Chronology getChronology​(java.lang.String readChronology, java.util.Locale locale2)  
      private java.text.SimpleDateFormat setDateFormat​(java.lang.String format, java.util.Locale formatLocale)  
      private java.time.format.DateTimeFormatter setDateTimeFormatter​(java.lang.String format, java.util.Locale formatLocale)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • CSVDATE_NOT_DATE

        private static final java.lang.String CSVDATE_NOT_DATE
        See Also:
        Constant Field Values

      • readSdf

        private final java.text.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!

      • writeSdf

        private final java.text.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!

      • readDtf

        private final java.time.format.DateTimeFormatter readDtf
        The formatter for all inputs to TemporalAccessor representations.

      • writeDtf

        private final java.time.format.DateTimeFormatter writeDtf
        The formatter for all outputs from TemporalAccessor representations.

      • readTemporalConversionFunction

        private final java.util.function.BiFunction<java.time.format.DateTimeFormatter,​java.lang.String,​java.time.temporal.TemporalAccessor> readTemporalConversionFunction
        A reference to the function to use when converting from strings to TemporalAccessor-based values.

      • writeTemporalConversionFunction

        private final java.util.function.BiFunction<java.time.format.DateTimeFormatter,​java.time.temporal.TemporalAccessor,​java.lang.String> writeTemporalConversionFunction
        A reference to the function to use when converting from TemporalAccessor-based values to strings.

    • Constructor Detail

      • ConverterDate

        public ConverterDate​(java.lang.Class<?> type,
                     java.lang.String locale,
                     java.lang.String writeLocale,
                     java.util.Locale errorLocale,
                     java.lang.String readFormat,
                     java.lang.String writeFormat,
                     java.lang.String readChronology,
                     java.lang.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 - The type of the field being populated
        readFormat - The string to use for parsing the date. See CsvDate.value()
        writeFormat - The string to use for formatting the date. See CsvDate.writeFormat()
        locale - If not null or empty, specifies the locale used for converting locale-specific data types
        writeLocale - If not null or empty, specifies the locale used for converting locale-specific data types for writing
        errorLocale - The locale to use for error messages
        readChronology - The Chronology to be used for reading if TemporalAccessor-based fields are in use
        writeChronology - The Chronology to be used for writing if TemporalAccessor-based fields are in use

    • Method Detail

      • determineWriteTemporalConversionFunction

        private java.util.function.BiFunction<java.time.format.DateTimeFormatter,​java.time.temporal.TemporalAccessor,​java.lang.String> determineWriteTemporalConversionFunction​(java.lang.Class<?> type)

      • determineReadTemporalConversionFunction

        private java.util.function.BiFunction<java.time.format.DateTimeFormatter,​java.lang.String,​java.time.temporal.TemporalAccessor> determineReadTemporalConversionFunction​(java.lang.Class<?> type)

      • setDateFormat

        private java.text.SimpleDateFormat setDateFormat​(java.lang.String format,
                                                 java.util.Locale formatLocale)

      • setDateTimeFormatter

        private java.time.format.DateTimeFormatter setDateTimeFormatter​(java.lang.String format,
                                                                java.util.Locale formatLocale)

      • getChronology

        private java.time.chrono.Chronology getChronology​(java.lang.String readChronology,
                                                  java.util.Locale locale2)

      • convertToRead

        public java.lang.Object convertToRead​(java.lang.String value)
                               throws CsvDataTypeMismatchException
        Description copied from interface: CsvConverter
        Method for converting from a string to the proper data type of the destination field.
        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

        public java.lang.String convertToWrite​(java.lang.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.
        Specified by:
        convertToWrite in interface CsvConverter
        Overrides:
        convertToWrite in class AbstractCsvConverter
        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