Package com.univocity.parsers.conversions

Class FormattedDateConversion

  • All Implemented Interfaces:
    Conversion<java.lang.Object,​java.lang.String>
    public class FormattedDateConversion
extends java.lang.Object
implements Conversion<java.lang.Object,​java.lang.String>
    Converts objects of different date types (java.util.Date and java.util.Calendar) to a formatted date String.

    The reverse conversion is not supported.

    The date patterns must follow the pattern rules of SimpleDateFormat

    Author:
    Univocity Software Pty Ltd - parsers@univocity.com
    See Also:
    SimpleDateFormat

    • Constructor Summary

      Constructors 
      Constructor Description
      FormattedDateConversion​(java.lang.String format, java.util.Locale locale, java.lang.String valueIfObjectIsNull)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String execute​(java.lang.Object input)
      Converts a value of type I to a value of type O.
      java.lang.Object revert​(java.lang.String input)
      Unsupported operation.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FormattedDateConversion

        public FormattedDateConversion​(java.lang.String format,
                               java.util.Locale locale,
                               java.lang.String valueIfObjectIsNull)
        Parameters:
        format - The pattern to be used to convert an input date into a String in execute(Object).
        locale - the Locale that determines how the date mask should be formatted.
        valueIfObjectIsNull - default String value to be returned when an input is null . Used when execute(Object) is invoked with a null parameter.

    • Method Detail

      • execute

        public java.lang.String execute​(java.lang.Object input)
        Description copied from interface: Conversion
        Converts a value of type I to a value of type O. When used in conjunction with the Convert annotation, this method will perform the conversion from a parsed input String (if no other conversion has been applied before) to a value of the desired type, and the result will be assigned to the annotated field. Note that conversions can be chained so you need to make sure the input type of any previous conversion is compatible with I
        Specified by:
        execute in interface Conversion<java.lang.Object,​java.lang.String>
        Parameters:
        input - the input of type I to be converted to an object of type O
        Returns:
        the conversion result.

      • revert

        public java.lang.Object revert​(java.lang.String input)
        Unsupported operation.
        Specified by:
        revert in interface Conversion<java.lang.Object,​java.lang.String>
        Parameters:
        input - the input be converted.
        Returns:
        throws a UnsupportedOperationException