org.apache.commons.convert
Class DateTimeConverters.CalendarToString

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

All Implemented Interfaces:

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

Enclosing class:

DateTimeConverters

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

An object that converts a Calendar to a String.

DateTimeConverters.CalendarToString

public DateTimeConverters.CalendarToString()

convert

public String convert(Calendar 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(Calendar 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