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.Period;
20
21 /**
22 * {@link org.apache.commons.beanutils2.Converter} implementation that handles conversion to and from <strong>java.time.Period</strong> objects.
23 * <p>
24 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
25 * </p>
26 *
27 * @since 2.0
28 * @see java.time.Period
29 */
30 public final class PeriodConverter extends AbstractConverter<Period> {
31
32 /**
33 * Constructs a <strong>java.time.Period</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
34 */
35 public PeriodConverter() {
36 }
37
38 /**
39 * Constructs a <strong>java.time.Period</strong> <em>Converter</em> that returns a default value if an error occurs.
40 *
41 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
42 */
43 public PeriodConverter(final Period defaultValue) {
44 super(defaultValue);
45 }
46
47 /**
48 * <p>
49 * Converts a java.time.Period or object into a String.
50 * </p>
51 *
52 * @param <T> Target type of the conversion.
53 * @param type Data type to which this value should be converted.
54 * @param value The input value to be converted.
55 * @return The converted value.
56 * @throws Throwable if an error occurs converting to the specified type
57 * @since 2.0
58 */
59 @Override
60 protected <T> T convertToType(final Class<T> type, final Object value) throws Throwable {
61 if (Period.class.equals(type)) {
62 return type.cast(Period.parse(String.valueOf(value)));
63 }
64
65 throw conversionException(type, value);
66 }
67
68 /**
69 * Gets the default type this {@code Converter} handles.
70 *
71 * @return The default type this {@code Converter} handles.
72 * @since 2.0
73 */
74 @Override
75 protected Class<Period> getDefaultType() {
76 return Period.class;
77 }
78
79 }