View Javadoc
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   * @author James Strachan
29   * @version $Revision: 690380 $ $Date: 2008-08-29 16:04:38 -0400 (Fri, 29 Aug 2008) $
30   * @since 1.6
31   */
32  public final class FileConverter extends AbstractConverter {
33  
34      /**
35       * Construct a <b>java.io.File</b> <i>Converter</i> that throws
36       * a <code>ConversionException</code> if an error occurs.
37       */
38      public FileConverter() {
39          super();
40      }
41  
42      /**
43       * Construct a <b>java.io.File</b> <i>Converter</i> that returns
44       * a default value if an error occurs.
45       *
46       * @param defaultValue The default value to be returned
47       * if the value to be converted is missing or an error
48       * occurs converting the value.
49       */
50      public FileConverter(Object defaultValue) {
51          super(defaultValue);
52      }
53  
54      /**
55       * Return the default type this <code>Converter</code> handles.
56       *
57       * @return The default type this <code>Converter</code> handles.
58       * @since 1.8.0
59       */
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 type Data type to which this value should be converted.
68       * @param value The input value to be converted.
69       * @return The converted value.
70       * @throws Throwable if an error occurs converting to the specified type
71       * @since 1.8.0
72       */
73      protected Object convertToType(Class type, Object value) throws Throwable {
74          return new File(value.toString());
75      }
76  }