View Javadoc

1   /*
2    * The SmartWeb Framework
3    * Copyright (C) 2004-2006
4    *
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2.1 of the License, or (at your option) any later version.
9    *
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18   *
19   * For further informations on the SmartWeb Framework please visit
20   *
21   *                        http://smartweb.sourceforge.net
22   */
23   
24  package net.smartlab.web.bean;
25  
26  import java.util.Locale;
27  
28  /**
29   * TODO Documentation
30   *
31   * @author gperrone
32   * @author rlogiacco
33   */
34  public abstract class Converter {
35  
36  	/*# net.smartlab.web.bean.ConversionException ce */
37  
38  	/**
39  	 * TODO documentation
40  	 * 
41  	 * @param type the target type
42  	 * @param value the value to be converted
43  	 * @param locale the locale to be used for the conversion
44  	 * @return an instance of the specified <code>type</code> which represents
45  	 *         the converted input value
46  	 * @throws ConversionException if something wrong occurs during conversion
47  	 *             or if the conversion couldn't be performed
48  	 */
49  	public abstract Object convert(Class type, Object value, Locale locale) throws ConversionException;
50  
51  }