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