    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 */
    017
    018package org.apache.commons.beanutils2.sql.converters.locale;
    019
    020import java.sql.Timestamp;
    021import java.text.ParseException;
    022import java.util.Locale;
    023
    024import org.apache.commons.beanutils2.ConversionException;
    025import org.apache.commons.beanutils2.locale.converters.DateLocaleConverter;
    026
    027/**
    028 * Standard {@link org.apache.commons.beanutils2.locale.LocaleConverter} implementation that converts an incoming locale-sensitive String into a
    029 * {@link java.sql.Timestamp} object, optionally using a default value or throwing a {@link org.apache.commons.beanutils2.ConversionException} if a conversion
    030 * error occurs.
    031 */
    032public class SqlTimestampLocaleConverter extends DateLocaleConverter<Timestamp> {
    033
    034    /**
    035     * Builds instances of {@link SqlTimestampLocaleConverter}.
    036     */
    037    public static class Builder extends DateLocaleConverter.Builder<Builder, Timestamp> {
    038
    039        @Override
    040        public SqlTimestampLocaleConverter get() {
    041            return new SqlTimestampLocaleConverter(defaultValue, locale, pattern, useDefault || defaultValue != null, localizedPattern, isLenient());
    042        }
    043
    044    }
    045
    046    /**
    047     * Constructs a new builder.
    048     *
    049     * @return a new builder.
    050     */
    051    public static Builder builder() {
    052        return new Builder();
    053    }
    054
    055    private SqlTimestampLocaleConverter(final Timestamp defaultValue, final Locale locale, final String pattern, final boolean useDefault,
    056            final boolean locPattern, final boolean lenient) {
    057        super(defaultValue, locale, pattern, useDefault, locPattern, lenient);
    058    }
    059
    060    /**
    061     * Converts the specified locale-sensitive input object into an output object of the specified type.
    062     *
    063     * @param value   The input object to be converted
    064     * @param pattern The pattern is used for the conversion
    065     * @return The converted value
    066     * @throws ConversionException if conversion cannot be performed successfully
    067     * @throws ParseException      if an error occurs parsing a String to a Number
    068     */
    069    @Override
    070    protected Timestamp parse(final Object value, final String pattern) throws ParseException {
    071        // MUST cast to java.util.Date to avoid a CCE.
    072        return new Timestamp(((java.util.Date) super.parse(value, pattern)).getTime());
    073    }
    074}