org.apache.commons.convert
Class DateTimeConverters.StringToTimestamp

java.lang.Object
  extended by org.apache.commons.convert.AbstractConverter<S,T>
      extended by org.apache.commons.convert.AbstractLocalizedConverter<String,Timestamp>
          extended by org.apache.commons.convert.DateTimeConverters.StringToTimestamp
All Implemented Interfaces:
Converter<String,Timestamp>, ConverterLoader, LocalizedConverter<String,Timestamp>
Enclosing class:
DateTimeConverters

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

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


Constructor Summary
DateTimeConverters.StringToTimestamp()
           
 
Method Summary
 boolean canConvert(Class<?> sourceClass, Class<?> targetClass)
          Returns true if this object can convert sourceClass to targetClass.
 Timestamp convert(String obj)
          Converts obj to T.
 Timestamp convert(String obj, Locale locale, TimeZone timeZone, String formatString)
          Converts obj to a java.sql.Timestamp.
 
Methods inherited from class org.apache.commons.convert.AbstractLocalizedConverter
convert
 
Methods inherited from class org.apache.commons.convert.AbstractConverter
getSourceClass, getTargetClass, loadConverters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.commons.convert.Converter
getSourceClass, getTargetClass
 

Constructor Detail

DateTimeConverters.StringToTimestamp

public DateTimeConverters.StringToTimestamp()
Method Detail

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,Timestamp>
Overrides:
canConvert in class AbstractConverter<String,Timestamp>
Parameters:
sourceClass - The source Class
targetClass - The target Class
Returns:
true if this object can convert sourceClass to targetClass.

convert

public Timestamp convert(String 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 Timestamp convert(String obj,
                         Locale locale,
                         TimeZone timeZone,
                         String formatString)
                  throws ConversionException
Converts obj to a java.sql.Timestamp.

Note that the string representation is referenced to the timeZone argument, not UTC. The Timestamp that is returned is adjusted to UTC. This behavior is intended to accommodate user-entered timestamps, where users are accustomed to using 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


Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.