org.apache.commons.convert
Class DateTimeConverters.TimestampToString

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

All Implemented Interfaces:

Converter<Timestamp,String>, ConverterLoader, LocalizedConverter<Timestamp,String>

Enclosing class:

DateTimeConverters

public static class DateTimeConverters.TimestampToString
extends AbstractLocalizedConverter<Timestamp,String>

An object that converts a java.sql.Timestamp to a String.

DateTimeConverters.TimestampToString

public DateTimeConverters.TimestampToString()

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

Overrides:

canConvert in class AbstractConverter<Timestamp,String>

Parameters:

sourceClass - The source Class

targetClass - The target Class

Returns:

true if this object can convert sourceClass to targetClass.

convert

public String convert(Timestamp obj)
               throws ConversionException

Description copied from interface: Converter

Converts obj to T.

Parameters:

obj - The source Object to convert

Returns:

The converted Object

Throws:

ConversionException

convert

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

Converts obj to a String using the supplied time zone.

Note that the string representation is referenced to the timeZone argument, not UTC. The Timestamp is adjusted to the specified time zone before conversion. This behavior is intended to accommodate user interfaces, where users are accustomed to viewing timestamps in their own time zone.

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