org.apache.commons.beanutils
Class ConvertUtilsBean

java.lang.Object
  |
  +--org.apache.commons.beanutils.ConvertUtilsBean

public class ConvertUtilsBean

extends java.lang.Object

Utility methods for converting String scalar values to objects of the specified Class, String arrays to arrays of the specified Class. The actual Converter instance to be used can be registered for each possible destination Class. Unless you override them, standard Converter instances are provided for all of the following destination Classes:

• java.lang.BigDecimal
• java.lang.BigInteger
• boolean and java.lang.Boolean
• byte and java.lang.Byte
• char and java.lang.Character
• java.lang.Class
• double and java.lang.Double
• float and java.lang.Float
• int and java.lang.Integer
• long and java.lang.Long
• short and java.lang.Short
• java.lang.String
• java.io.File
• java.net.URL
• java.sql.Date
• java.sql.Time
• java.sql.Timestamp

For backwards compatibility, the standard Converters for primitive types (and the corresponding wrapper classes) return a defined default value when a conversion error occurs. If you prefer to have a ConversionException thrown instead, replace the standard Converter instances with instances created with the zero-arguments constructor. For example, to cause the Converters for integers to throw an exception on conversion errors, you could do this:

   // No-args constructor gets the version that throws exceptions
   Converter myConverter =
    new org.apache.commons.beanutils.converter.IntegerConverter();
   ConvertUtils.register(myConverter, Integer.TYPE);    // Native type
   ConvertUtils.register(myConverter, Integer.class);   // Wrapper class
 

Since:

1.7

Version:

$Revision: 1.12.2.1 $ $Date: 2004/07/27 21:44:26 $

Author:

Craig R. McClanahan, Ralph Schaer, Chris Audley, James Strachan

Field Summary

private FastHashMap	converters The set of Converters that can be used to convert Strings into objects of a specified Class, keyed by the destination Class.
private java.lang.Boolean	defaultBoolean Deprecated. Register replacement converters for Boolean.TYPE and Boolean.class instead
private java.lang.Byte	defaultByte Deprecated. Register replacement converters for Byte.TYPE and Byte.class instead
private java.lang.Character	defaultCharacter Deprecated. Register replacement converters for Character.TYPE and Character.class instead
private java.lang.Double	defaultDouble Deprecated. Register replacement converters for Double.TYPE and Double.class instead
private java.lang.Float	defaultFloat Deprecated. Register replacement converters for Float.TYPE and Float.class instead
private java.lang.Integer	defaultInteger Deprecated. Register replacement converters for Integer.TYPE and Integer.class instead
private java.lang.Long	defaultLong Deprecated. Register replacement converters for Long.TYPE and Long.class instead
private static java.lang.Short	defaultShort Deprecated. Register replacement converters for Short.TYPE and Short.class instead
private org.apache.commons.logging.Log	log The Log instance for this class.

Constructor Summary

ConvertUtilsBean()
Construct a bean with standard converters registered

Method Summary

java.lang.String	convert(java.lang.Object value) Convert the specified value into a String.
java.lang.Object	convert(java.lang.String[] values, java.lang.Class clazz) Convert an array of specified values to an array of objects of the specified class (if possible).
java.lang.Object	convert(java.lang.String value, java.lang.Class clazz) Convert the specified value to an object of the specified class (if possible).
void	deregister() Remove all registered Converters, and re-establish the standard Converters.
void	deregister(java.lang.Class clazz) Remove any registered Converter for the specified destination Class.
boolean	getDefaultBoolean() Deprecated. Register replacement converters for Boolean.TYPE and Boolean.class instead
byte	getDefaultByte() Deprecated. Register replacement converters for Byte.TYPE and Byte.class instead
char	getDefaultCharacter() Deprecated. Register replacement converters for Character.TYPE and Character.class instead
double	getDefaultDouble() Deprecated. Register replacement converters for Double.TYPE and Double.class instead
float	getDefaultFloat() Deprecated. Register replacement converters for Float.TYPE and Float.class instead
int	getDefaultInteger() Deprecated. Register replacement converters for Integer.TYPE and Integer.class instead
long	getDefaultLong() Deprecated. Register replacement converters for Long.TYPE and Long.class instead
short	getDefaultShort() Deprecated. Register replacement converters for Short.TYPE and Short.class instead
protected static ConvertUtilsBean	getInstance() Get singleton instance
Converter	lookup(java.lang.Class clazz) Look up and return any registered Converter for the specified destination class; if there is no registered Converter, return null.
private void	register(java.lang.Class clazz, Converter converter) strictly for convenience since it has same parameter order as Map.put
void	register(Converter converter, java.lang.Class clazz) Register a custom Converter for the specified destination Class, replacing any previously registered Converter.
void	setDefaultBoolean(boolean newDefaultBoolean) Deprecated. Register replacement converters for Boolean.TYPE and Boolean.class instead
void	setDefaultByte(byte newDefaultByte) Deprecated. Register replacement converters for Byte.TYPE and Byte.class instead
void	setDefaultCharacter(char newDefaultCharacter) Deprecated. Register replacement converters for Character.TYPE and Character.class instead
void	setDefaultDouble(double newDefaultDouble) Deprecated. Register replacement converters for Double.TYPE and Double.class instead
void	setDefaultFloat(float newDefaultFloat) Deprecated. Register replacement converters for Float.TYPE and Float.class instead
void	setDefaultInteger(int newDefaultInteger) Deprecated. Register replacement converters for Integer.TYPE and Integer.class instead
void	setDefaultLong(long newDefaultLong) Deprecated. Register replacement converters for Long.TYPE and Long.class instead
void	setDefaultShort(short newDefaultShort) Deprecated. Register replacement converters for Short.TYPE and Short.class instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

converters

private FastHashMap converters

The set of Converters that can be used to convert Strings into objects of a specified Class, keyed by the destination Class.

log

private org.apache.commons.logging.Log log

The Log instance for this class.

defaultBoolean

private java.lang.Boolean defaultBoolean

Deprecated. Register replacement converters for Boolean.TYPE and Boolean.class instead

The default value for Boolean conversions.

defaultByte

private java.lang.Byte defaultByte

Deprecated. Register replacement converters for Byte.TYPE and Byte.class instead

The default value for Byte conversions.

defaultCharacter

private java.lang.Character defaultCharacter

Deprecated. Register replacement converters for Character.TYPE and Character.class instead

The default value for Character conversions.

defaultDouble

private java.lang.Double defaultDouble

Deprecated. Register replacement converters for Double.TYPE and Double.class instead

The default value for Double conversions.

defaultFloat

private java.lang.Float defaultFloat

Deprecated. Register replacement converters for Float.TYPE and Float.class instead

The default value for Float conversions.

defaultInteger

private java.lang.Integer defaultInteger

Deprecated. Register replacement converters for Integer.TYPE and Integer.class instead

The default value for Integer conversions.

defaultLong

private java.lang.Long defaultLong

Deprecated. Register replacement converters for Long.TYPE and Long.class instead

The default value for Long conversions.

defaultShort

private static java.lang.Short defaultShort

Deprecated. Register replacement converters for Short.TYPE and Short.class instead

The default value for Short conversions.

Constructor Detail

ConvertUtilsBean

public ConvertUtilsBean()

Construct a bean with standard converters registered

Method Detail

getInstance

protected static ConvertUtilsBean getInstance()

Get singleton instance

getDefaultBoolean

public boolean getDefaultBoolean()

Deprecated. Register replacement converters for Boolean.TYPE and Boolean.class instead

Gets the default value for Boolean conversions.

setDefaultBoolean

public void setDefaultBoolean(boolean newDefaultBoolean)

Deprecated. Register replacement converters for Boolean.TYPE and Boolean.class instead

Sets the default value for Boolean conversions.

getDefaultByte

public byte getDefaultByte()

Deprecated. Register replacement converters for Byte.TYPE and Byte.class instead

Gets the default value for Byte conversions.

setDefaultByte

public void setDefaultByte(byte newDefaultByte)

Deprecated. Register replacement converters for Byte.TYPE and Byte.class instead

Sets the default value for Byte conversions.

getDefaultCharacter

public char getDefaultCharacter()

Deprecated. Register replacement converters for Character.TYPE and Character.class instead

Gets the default value for Character conversions.

setDefaultCharacter

public void setDefaultCharacter(char newDefaultCharacter)

Deprecated. Register replacement converters for Character.TYPE and Character.class instead

Sets the default value for Character conversions.

getDefaultDouble

public double getDefaultDouble()

Deprecated. Register replacement converters for Double.TYPE and Double.class instead

Gets the default value for Double conversions.

setDefaultDouble

public void setDefaultDouble(double newDefaultDouble)

Deprecated. Register replacement converters for Double.TYPE and Double.class instead

Sets the default value for Double conversions.

getDefaultFloat

public float getDefaultFloat()

Deprecated. Register replacement converters for Float.TYPE and Float.class instead

Gets the default value for Float conversions.

setDefaultFloat

public void setDefaultFloat(float newDefaultFloat)

Deprecated. Register replacement converters for Float.TYPE and Float.class instead

Sets the default value for Float conversions.

getDefaultInteger

public int getDefaultInteger()

Deprecated. Register replacement converters for Integer.TYPE and Integer.class instead

Gets the default value for Integer conversions.

setDefaultInteger

public void setDefaultInteger(int newDefaultInteger)

Deprecated. Register replacement converters for Integer.TYPE and Integer.class instead

Sets the default value for Integer conversions.

getDefaultLong

public long getDefaultLong()

Deprecated. Register replacement converters for Long.TYPE and Long.class instead

Gets the default value for Long conversions.

setDefaultLong

public void setDefaultLong(long newDefaultLong)

Deprecated. Register replacement converters for Long.TYPE and Long.class instead

Sets the default value for Long conversions.

getDefaultShort

public short getDefaultShort()

Deprecated. Register replacement converters for Short.TYPE and Short.class instead

Gets the default value for Short conversions.

setDefaultShort

public void setDefaultShort(short newDefaultShort)

Deprecated. Register replacement converters for Short.TYPE and Short.class instead

Sets the default value for Short conversions.

convert

public java.lang.String convert(java.lang.Object value)

Convert the specified value into a String. If the specified value is an array, the first element (converted to a String) will be returned. The registered Converter for the java.lang.String class will be used, which allows applications to customize Object->String conversions (the default implementation simply uses toString()).

Parameters:

value - Value to be converted (may be null)

convert

public java.lang.Object convert(java.lang.String value,
                                java.lang.Class clazz)

Convert the specified value to an object of the specified class (if possible). Otherwise, return a String representation of the value.

Parameters:

value - Value to be converted (may be null)

clazz - Java class to be converted to

Throws:

ConversionException - if thrown by an underlying Converter

convert

public java.lang.Object convert(java.lang.String[] values,
                                java.lang.Class clazz)

Convert an array of specified values to an array of objects of the specified class (if possible). If the specified Java class is itself an array class, this class will be the type of the returned value. Otherwise, an array will be constructed whose component type is the specified class.

Parameters:

values - Values to be converted (may be null)

clazz - Java array or element class to be converted to

Throws:

ConversionException - if thrown by an underlying Converter

deregister

public void deregister()

Remove all registered Converters, and re-establish the standard Converters.

register

private void register(java.lang.Class clazz,
                      Converter converter)

strictly for convenience since it has same parameter order as Map.put

deregister

public void deregister(java.lang.Class clazz)

Remove any registered Converter for the specified destination Class.

Parameters:

clazz - Class for which to remove a registered Converter

lookup

public Converter lookup(java.lang.Class clazz)

Look up and return any registered Converter for the specified destination class; if there is no registered Converter, return null.

Parameters:

clazz - Class for which to return a registered Converter

register

public void register(Converter converter,
                     java.lang.Class clazz)

Register a custom Converter for the specified destination Class, replacing any previously registered Converter.

Parameters:

converter - Converter to be registered

clazz - Destination class for conversions performed by this Converter