Class DateConversion
java.lang.Object
com.univocity.parsers.conversions.NullConversion<String,T>
com.univocity.parsers.conversions.ObjectConversion<Date>
com.univocity.parsers.conversions.DateConversion
- All Implemented Interfaces:
Conversion<String,
,Date> FormattedConversion<SimpleDateFormat>
public class DateConversion
extends ObjectConversion<Date>
implements FormattedConversion<SimpleDateFormat>
Converts Strings to instances of
Date
and vice versa.
This class supports multiple date formats. For example, you can define conversions from dates represented by different Strings such as "2001/05/02 and Dec/2013".
The reverse conversion from a Date to String (in revert(Date)
will return a formatted String using the date pattern provided in this class constructor
The date patterns must follows the pattern rules of SimpleDateFormat
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDateConversion
(String... dateFormats) Defines a conversion from String toDate
using a sequence of acceptable date patterns.DateConversion
(Date valueIfStringIsNull, String valueIfObjectIsNull, String... dateFormats) Defines a conversion from String toDate
using a sequence of acceptable date patterns.DateConversion
(Locale locale, String... dateFormats) Defines a conversion from String toDate
using a sequence of acceptable date patterns.DateConversion
(Locale locale, Date valueIfStringIsNull, String valueIfObjectIsNull, String... dateFormats) Defines a conversion from String toDate
using a sequence of acceptable date patterns.DateConversion
(TimeZone timeZone, Locale locale, Date valueIfStringIsNull, String valueIfObjectIsNull, String... dateFormats) Defines a conversion from String toDate
using a sequence of acceptable date patterns. -
Method Summary
Modifier and TypeMethodDescriptionprotected Date
fromString
(String input) Converts a formatted date String to an instance of Date.Returns the formatter objectsConverts Date to a formatted date String.Methods inherited from class com.univocity.parsers.conversions.ObjectConversion
execute, fromInput, getValueIfObjectIsNull, getValueIfStringIsNull, setValueIfObjectIsNull, setValueIfStringIsNull, undo
Methods inherited from class com.univocity.parsers.conversions.NullConversion
getValueOnNullInput, getValueOnNullOutput, setValueOnNullInput, setValueOnNullOutput
-
Field Details
-
locale
-
timeZone
-
parsers
-
formats
-
-
Constructor Details
-
DateConversion
public DateConversion(TimeZone timeZone, Locale locale, Date valueIfStringIsNull, String valueIfObjectIsNull, String... dateFormats) Defines a conversion from String toDate
using a sequence of acceptable date patterns. This constructor assumes the output of a conversion should be null when input is null- Parameters:
timeZone
- theTimeZone
of the date to be formattedlocale
- theLocale
that determines how the date mask should be formatted.valueIfStringIsNull
- default Date value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.valueIfObjectIsNull
- default String value to be returned when a Date input is null. Used whenrevert(Date)
is invoked.dateFormats
- list of acceptable date patterns The first pattern in this sequence will be used to convert a Date into a String inrevert(Date)
.
-
DateConversion
public DateConversion(Locale locale, Date valueIfStringIsNull, String valueIfObjectIsNull, String... dateFormats) Defines a conversion from String toDate
using a sequence of acceptable date patterns. This constructor assumes the output of a conversion should be null when input is null- Parameters:
locale
- theLocale
that determines how the date mask should be formatted.valueIfStringIsNull
- default Date value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.valueIfObjectIsNull
- default String value to be returned when a Date input is null. Used whenrevert(Date)
is invoked.dateFormats
- list of acceptable date patterns The first pattern in this sequence will be used to convert a Date into a String inrevert(Date)
.
-
DateConversion
Defines a conversion from String toDate
using a sequence of acceptable date patterns. This constructor assumes the output of a conversion should be null when input is null- Parameters:
valueIfStringIsNull
- default Date value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.valueIfObjectIsNull
- default String value to be returned when a Date input is null. Used whenrevert(Date)
is invoked.dateFormats
- list of acceptable date patterns The first pattern in this sequence will be used to convert a Date into a String inrevert(Date)
.
-
DateConversion
Defines a conversion from String toDate
using a sequence of acceptable date patterns. This constructor assumes the output of a conversion should be null when input is null- Parameters:
locale
- theLocale
that determines how the date mask should be formatted.dateFormats
- list of acceptable date patterns The first pattern in this sequence will be used to convert a Date into a String inrevert(Date)
.
-
DateConversion
Defines a conversion from String toDate
using a sequence of acceptable date patterns. This constructor assumes the output of a conversion should be null when input is null- Parameters:
dateFormats
- list of acceptable date patterns The first pattern in this sequence will be used to convert a Date into a String inrevert(Date)
.
-
-
Method Details
-
revert
Converts Date to a formatted date String.The pattern used to generate the formatted date is the first date pattern provided in the constructor of this class
- Specified by:
revert
in interfaceConversion<String,
Date> - Overrides:
revert
in classObjectConversion<Date>
- Parameters:
input
- the Date to be converted to a String- Returns:
- a formatted date String representing the date provided by the given Date, or the value of
valueIfObjectIsNull
if the Date parameter is null.
-
fromString
Converts a formatted date String to an instance of Date.The pattern in the formatted date must match one of the date patterns provided in the constructor of this class.
- Specified by:
fromString
in classObjectConversion<Date>
- Parameters:
input
- the String containing a formatted date which must be converted to a Date- Returns:
- the Date instance containing the date information represented by the given String, or the value of
valueIfObjectIsNull
if the String input is null.
-
getFormatterObjects
Description copied from interface:FormattedConversion
Returns the formatter objects- Specified by:
getFormatterObjects
in interfaceFormattedConversion<SimpleDateFormat>
- Returns:
- the formatter objects used to apply formatting to values to generate formatted Strings, and parsing formatted Strings into values
-
getTimeZone
-