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: 555845 $ $Date: 2007-07-13 03:52:05 +0100 (Fri, 13 Jul 2007) $
    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(File.class);
    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(File.class, defaultValue);
    52      }
    53
    54      /***
    55       * <p>Convert the input object into a java.io.File.</p>
    56       *
    57       * @param type Data type to which this value should be converted.
    58       * @param value The input value to be converted.
    59       * @return The converted value.
    60       * @throws Throwable if an error occurs converting to the specified type
    61       */
    62      protected Object convertToType(Class type, Object value) throws Throwable {
    63          return new File(value.toString());
    64      }
    65  }