org.apache.commons.beanutils.converters.FileConverter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.beanutils.converters;
import java.io.File;
/**
* {@link org.apache.commons.beanutils.Converter} implementaion that handles conversion
* to and from java.io.File objects.
*
* Can be configured to either return a default value or throw a
* ConversionException if a conversion error occurs.
*
* @version $Id: FileConverter.java 1632171 2014-10-15 20:15:17Z ggregory $
* @since 1.6
*/
public final class FileConverter extends AbstractConverter {
/**
* Construct a java.io.File Converter that throws
* a ConversionException if an error occurs.
*/
public FileConverter() {
super();
}
/**
* Construct a java.io.File Converter that returns
* a default value if an error occurs.
*
* @param defaultValue The default value to be returned
* if the value to be converted is missing or an error
* occurs converting the value.
*/
public FileConverter(final Object defaultValue) {
super(defaultValue);
}
/**
* Return the default type this Converter handles.
*
* @return The default type this Converter handles.
* @since 1.8.0
*/
@Override
protected Class getDefaultType() {
return File.class;
}
/**
*
Convert the input object into a java.io.File.
*
* @param The target type of the conversion.
* @param type Data type to which this value should be converted.
* @param value The input value to be converted.
* @return The converted value.
* @throws Throwable if an error occurs converting to the specified type
* @since 1.8.0
*/
@Override
protected T convertToType(final Class type, final Object value) throws Throwable {
if (File.class.equals(type)) {
return type.cast(new File(value.toString()));
}
throw conversionException(type, value);
}
}