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.converters;
18
19 import java.time.OffsetDateTime;
20
21 /**
22 * {@link DateTimeConverter} implementation that handles conversion to and from <strong>java.time.OffsetDateTime</strong> objects.
23 * <p>
24 * This implementation can be configured to handle conversion either by using a Locale's default format or by specifying a set of format patterns (note, there
25 * is no default String conversion for Calendar). See the {@link DateTimeConverter} documentation for further details.
26 * </p>
27 * <p>
28 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
29 * </p>
30 *
31 * @since 2.0
32 * @see java.time.OffsetDateTime
33 */
34 public final class OffsetDateTimeConverter extends DateTimeConverter<OffsetDateTime> {
35
36 /**
37 * Constructs a <strong>java.time.OffsetDateTime</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
38 */
39 public OffsetDateTimeConverter() {
40 }
41
42 /**
43 * Constructs a <strong>java.time.OffsetDateTime</strong> <em>Converter</em> that returns a default value if an error occurs.
44 *
45 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
46 */
47 public OffsetDateTimeConverter(final OffsetDateTime defaultValue) {
48 super(defaultValue);
49 }
50
51 /**
52 * Gets the default type this {@code Converter} handles.
53 *
54 * @return The default type this {@code Converter} handles.
55 */
56 @Override
57 protected Class<OffsetDateTime> getDefaultType() {
58 return OffsetDateTime.class;
59 }
60
61 }