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.Time;
20 import java.text.DateFormat;
21 import java.util.Locale;
22 import java.util.TimeZone;
23
24 import org.apache.commons.beanutils2.converters.DateTimeConverter;
25
26 /**
27 * {@link DateTimeConverter} implementation that handles conversion to and from <strong>java.sql.Time</strong> objects.
28 * <p>
29 * This implementation can be configured to handle conversion either by using java.sql.Time's default String conversion, or by using a Locale's default format
30 * or by specifying a set of format patterns. See the {@link DateTimeConverter} documentation for further details.
31 * <p>
32 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
33 *
34 * @since 1.3
35 */
36 public final class SqlTimeConverter extends DateTimeConverter<Time> {
37
38 /**
39 * Constructs a <strong>java.sql.Time</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
40 */
41 public SqlTimeConverter() {
42 }
43
44 /**
45 * Constructs a <strong>java.sql.Time</strong> <em>Converter</em> that returns a default value if an error occurs.
46 *
47 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
48 */
49 public SqlTimeConverter(final Time defaultValue) {
50 super(defaultValue);
51 }
52
53 /**
54 * Gets the default type this {@code Converter} handles.
55 *
56 * @return The default type this {@code Converter} handles.
57 * @since 1.8.0
58 */
59 @Override
60 protected Class<Time> getDefaultType() {
61 return Time.class;
62 }
63
64 /**
65 * @since 1.8.0
66 */
67 @Override
68 protected DateFormat getFormat(final Locale locale, final TimeZone timeZone) {
69 DateFormat format = null;
70 if (locale == null) {
71 format = DateFormat.getTimeInstance(DateFormat.SHORT);
72 } else {
73 format = DateFormat.getTimeInstance(DateFormat.SHORT, locale);
74 }
75 if (timeZone != null) {
76 format.setTimeZone(timeZone);
77 }
78 return format;
79 }
80
81 }