org.apache.commons.beanutils.locale.LocaleConverter Maven / Gradle / Ivy
Show all versions of commons-beanutils Show documentation
/*
* 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.locale;
import org.apache.commons.beanutils.Converter;
/**
* General purpose locale-sensitive data type converter that can be registered and used
* within the BeanUtils package to manage the conversion of objects from
* one type to another.
*
* @version $Id$
*/
public interface LocaleConverter extends Converter {
/**
* Convert the specified locale-sensitive input object into an output object of the
* specified type.
*
* @param The desired target type of the conversion
* @param type Data type to which this value should be converted
* @param value The input value to be converted
* @param pattern The user-defined pattern is used for the input object formatting.
* @return The converted value
*
* @throws org.apache.commons.beanutils.ConversionException if conversion
* cannot be performed successfully or if the target type is not supported
*/
public T convert(Class type, Object value, String pattern);
}