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.converters;
018
019import java.time.Duration;
020
021/**
022 * {@link org.apache.commons.beanutils2.Converter} implementation that handles conversion to and from <strong>java.time.Duration</strong> objects.
023 * <p>
024 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
025 * </p>
026 *
027 * @since 2.0
028 * @see java.time.Duration
029 */
030public final class DurationConverter extends AbstractConverter<Duration> {
031
032    /**
033     * Constructs a <strong>java.time.Duration</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
034     */
035    public DurationConverter() {
036    }
037
038    /**
039     * Constructs a <strong>java.time.Duration</strong> <em>Converter</em> that returns a default value if an error occurs.
040     *
041     * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
042     */
043    public DurationConverter(final Duration defaultValue) {
044        super(defaultValue);
045    }
046
047    /**
048     * <p>
049     * Converts a java.time.Duration or object into a String.
050     * </p>
051     *
052     * @param <T>   Target type of the conversion.
053     * @param type  Data type to which this value should be converted.
054     * @param value The input value to be converted.
055     * @return The converted value.
056     * @throws Throwable if an error occurs converting to the specified type
057     * @since 2.0
058     */
059    @Override
060    protected <T> T convertToType(final Class<T> type, final Object value) throws Throwable {
061        if (Duration.class.equals(type)) {
062            return type.cast(Duration.parse(String.valueOf(value)));
063        }
064
065        throw conversionException(type, value);
066    }
067
068    /**
069     * Gets the default type this {@code Converter} handles.
070     *
071     * @return The default type this {@code Converter} handles.
072     * @since 2.0
073     */
074    @Override
075    protected Class<Duration> getDefaultType() {
076        return Duration.class;
077    }
078
079}