org.apache.commons.convert
Class DateTimeConverters.DateToString

java.lang.Object
  org.apache.commons.convert.AbstractConverter<S,T>
      org.apache.commons.convert.AbstractLocalizedConverter<Date,String>
          org.apache.commons.convert.DateTimeConverters.DateToString

All Implemented Interfaces:

Converter<Date,String>, ConverterLoader, LocalizedConverter<Date,String>

Enclosing class:

DateTimeConverters

public static class DateTimeConverters.DateToString
extends AbstractLocalizedConverter<Date,String>

An object that converts a java.util.Date to a String.

DateTimeConverters.DateToString

public DateTimeConverters.DateToString()

canConvert

public boolean canConvert(Class<?> sourceClass,
                          Class<?> targetClass)

Description copied from interface: Converter

Returns true if this object can convert sourceClass to targetClass.

Implementations can accomodate class hierarchy ranges by converting super classes or interfaces.

Specified by:

canConvert in interface Converter<Date,String>

Overrides:

canConvert in class AbstractConverter<Date,String>

Parameters:

sourceClass - The source Class

targetClass - The target Class

Returns:

true if this object can convert sourceClass to targetClass.

convert

public String convert(Date obj)
               throws ConversionException

Converts obj to a String formatted as DateTimeConverters.CALENDAR_FORMAT. The returned string is referenced to the default time zone.

Parameters:

obj - The source Object to convert

Returns:

The converted Object

Throws:

ConversionException

convert

public String convert(Date obj,
                      Locale locale,
                      TimeZone timeZone,
                      String formatString)
               throws ConversionException

Converts obj to a String using the supplied locale, time zone, and format string. If formatString is null, the string is formatted as DateTimeConverters.CALENDAR_FORMAT.

Parameters:

obj - The source Object to convert

locale - The locale used for conversion - must not be null

timeZone - The time zone used for conversion - must not be null

formatString - Optional formatting string

Returns:

The converted Object

Throws:

ConversionException