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