org.apache.commons.convert
Class DateTimeConverters.StringToDate

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

All Implemented Interfaces:

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

Enclosing class:

DateTimeConverters

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

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

DateTimeConverters.StringToDate

public DateTimeConverters.StringToDate()

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<String,Date>

Overrides:

canConvert in class AbstractConverter<String,Date>

Parameters:

sourceClass - The source Class

targetClass - The target Class

Returns:

true if this object can convert sourceClass to targetClass.

convert

public Date convert(String obj)
             throws ConversionException

Converts obj to a java.util.Date. The string must be formatted as DateTimeConverters.CALENDAR_FORMAT.

Parameters:

obj - The source Object to convert

Returns:

The converted Object

Throws:

ConversionException

convert

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

Converts obj to a java.util.Date. 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