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.Date;
020
021import org.apache.commons.beanutils2.converters.DateTimeConverter;
022
023/**
024 * {@link DateTimeConverter} implementation that handles conversion to and from <strong>java.sql.Date</strong> objects.
025 * <p>
026 * This implementation can be configured to handle conversion either by using java.sql.Date's default String conversion, or by using a Locale's default format
027 * or by specifying a set of format patterns. See the {@link DateTimeConverter} documentation for further details.
028 * <p>
029 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
030 *
031 * @since 1.3
032 */
033public final class SqlDateConverter extends DateTimeConverter<Date> {
034
035    /**
036     * Constructs a <strong>java.sql.Date</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
037     */
038    public SqlDateConverter() {
039    }
040
041    /**
042     * Constructs a <strong>java.sql.Date</strong> <em>Converter</em> that returns a default value if an error occurs.
043     *
044     * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
045     */
046    public SqlDateConverter(final Date defaultValue) {
047        super(defaultValue);
048    }
049
050    /**
051     * Gets the default type this {@code Converter} handles.
052     *
053     * @return The default type this {@code Converter} handles.
054     * @since 1.8.0
055     */
056    @Override
057    protected Class<Date> getDefaultType() {
058        return Date.class;
059    }
060
061}