001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.beanutils2.sql.converters;
018
019import java.sql.Timestamp;
020import java.text.DateFormat;
021import java.util.Locale;
022import java.util.TimeZone;
023
024import org.apache.commons.beanutils2.converters.DateTimeConverter;
025
026/**
027 * {@link DateTimeConverter} implementation that handles conversion to and from <strong>java.sql.Timestamp</strong> objects.
028 * <p>
029 * This implementation can be configured to handle conversion either by using java.sql.Timestamp's default String conversion, or by using a Locale's default
030 * format or by specifying a set of format patterns. See the {@link DateTimeConverter} documentation for further details.
031 * <p>
032 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
033 *
034 * @since 1.3
035 */
036public final class SqlTimestampConverter extends DateTimeConverter<Timestamp> {
037
038    /**
039     * Constructs a <strong>java.sql.Timestamp</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
040     */
041    public SqlTimestampConverter() {
042    }
043
044    /**
045     * Constructs a <strong>java.sql.Timestamp</strong> <em>Converter</em> that returns a default value if an error occurs.
046     *
047     * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
048     */
049    public SqlTimestampConverter(final Timestamp defaultValue) {
050        super(defaultValue);
051    }
052
053    /**
054     * Gets the default type this {@code Converter} handles.
055     *
056     * @return The default type this {@code Converter} handles.
057     * @since 1.8.0
058     */
059    @Override
060    protected Class<Timestamp> getDefaultType() {
061        return Timestamp.class;
062    }
063
064    /**
065     * @since 1.8.0
066     */
067    @Override
068    protected DateFormat getFormat(final Locale locale, final TimeZone timeZone) {
069        DateFormat format = null;
070        if (locale == null) {
071            format = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT);
072        } else {
073            format = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, locale);
074        }
075        if (timeZone != null) {
076            format.setTimeZone(timeZone);
077        }
078        return format;
079    }
080}