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
    18  package org.apache.commons.beanutils.locale;
    19
    20  import org.apache.commons.beanutils.Converter;
    21
    22
    23  /***
    24   * <p>General purpose locale-sensitive data type converter that can be registered and used
    25   * within the BeanUtils package to manage the conversion of objects from
    26   * one type to another.
    27   *
    28   * @author Yauheny Mikulski
    29   */
    30
    31  public interface LocaleConverter extends Converter {
    32
    33
    34      /***
    35       * Convert the specified locale-sensitive input object into an output object of the
    36       * specified type.
    37       *
    38       * @param type Data type to which this value should be converted
    39       * @param value The input value to be converted
    40       * @param pattern The user-defined pattern is used for the input object formatting.
    41       * @return The converted value
    42       *
    43       * @exception org.apache.commons.beanutils.ConversionException if conversion
    44       * cannot be performed successfully
    45       */
    46      public Object convert(Class type, Object value, String pattern);
    47  }