org.apache.commons.convert
Class DateTimeConverters.StringToCalendar

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

All Implemented Interfaces:

Converter<String,Calendar>, ConverterLoader, LocalizedConverter<String,Calendar>

Enclosing class:

DateTimeConverters

public static class DateTimeConverters.StringToCalendar
extends AbstractLocalizedConverter<String,Calendar>

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

DateTimeConverters.StringToCalendar

public DateTimeConverters.StringToCalendar()

convert

public Calendar convert(String obj)
                 throws ConversionException

Converts obj to a java.util.Calendar initialized to the default locale and time zone. The string must be formatted as DateTimeConverters.CALENDAR_FORMAT.

Parameters:

obj - The source Object to convert

Returns:

The converted Object

Throws:

ConversionException

convert

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

Converts obj to a java.util.Calendar initialized to the supplied locale and time zone. 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