View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.beanutils2.sql.converters;
18  
19  import java.sql.Date;
20  
21  import org.apache.commons.beanutils2.converters.DateTimeConverter;
22  
23  /**
24   * {@link DateTimeConverter} implementation that handles conversion to and from <strong>java.sql.Date</strong> objects.
25   * <p>
26   * 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
27   * or by specifying a set of format patterns. See the {@link DateTimeConverter} documentation for further details.
28   * <p>
29   * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
30   *
31   * @since 1.3
32   */
33  public final class SqlDateConverter extends DateTimeConverter<Date> {
34  
35      /**
36       * Constructs a <strong>java.sql.Date</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
37       */
38      public SqlDateConverter() {
39      }
40  
41      /**
42       * Constructs a <strong>java.sql.Date</strong> <em>Converter</em> that returns a default value if an error occurs.
43       *
44       * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
45       */
46      public SqlDateConverter(final Date defaultValue) {
47          super(defaultValue);
48      }
49  
50      /**
51       * Gets the default type this {@code Converter} handles.
52       *
53       * @return The default type this {@code Converter} handles.
54       * @since 1.8.0
55       */
56      @Override
57      protected Class<Date> getDefaultType() {
58          return Date.class;
59      }
60  
61  }