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.beanutils.converters;
18
19 import java.io.File;
20
21 /**
22 * {@link org.apache.commons.beanutils.Converter} implementaion that handles conversion
23 * to and from <b>java.io.File</b> objects.
24 * <p>
25 * Can be configured to either return a <i>default value</i> or throw a
26 * <code>ConversionException</code> if a conversion error occurs.
27 *
28 * @version $Id$
29 * @since 1.6
30 */
31 public final class FileConverter extends AbstractConverter {
32
33 /**
34 * Construct a <b>java.io.File</b> <i>Converter</i> that throws
35 * a <code>ConversionException</code> if an error occurs.
36 */
37 public FileConverter() {
38 super();
39 }
40
41 /**
42 * Construct a <b>java.io.File</b> <i>Converter</i> that returns
43 * a default value if an error occurs.
44 *
45 * @param defaultValue The default value to be returned
46 * if the value to be converted is missing or an error
47 * occurs converting the value.
48 */
49 public FileConverter(final Object defaultValue) {
50 super(defaultValue);
51 }
52
53 /**
54 * Return the default type this <code>Converter</code> handles.
55 *
56 * @return The default type this <code>Converter</code> handles.
57 * @since 1.8.0
58 */
59 @Override
60 protected Class<?> getDefaultType() {
61 return File.class;
62 }
63
64 /**
65 * <p>Convert the input object into a java.io.File.</p>
66 *
67 * @param <T> The target type of the conversion.
68 * @param type Data type to which this value should be converted.
69 * @param value The input value to be converted.
70 * @return The converted value.
71 * @throws Throwable if an error occurs converting to the specified type
72 * @since 1.8.0
73 */
74 @Override
75 protected <T> T convertToType(final Class<T> type, final Object value) throws Throwable {
76 if (File.class.equals(type)) {
77 return type.cast(new File(value.toString()));
78 }
79
80 throw conversionException(type, value);
81 }
82 }