com.phloc.commons.typeconvert

Class TypeConverter

java.lang.Object

com.phloc.commons.typeconvert.TypeConverter

@Immutable
public final class TypeConverter
extends Object

Helper class for converting base types likes "boolean" to object types like "Boolean".
Uses TypeConverterRegistry.getFuzzyConverter(Class, Class) for retrieving a registered converter. If no converter is found, it is checked whether a mapping from a primitive type to an object type exists.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static <DSTTYPE> DSTTYPE	convert(boolean aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convert(byte aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convert(char aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convert(double aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convert(float aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convert(int aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convert(long aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convert(short aSrcValue, Class<DSTTYPE> aDstClass)
static <DSTTYPE> DSTTYPE	convertIfNecessary(ITypeConverterProvider aTypeConverterProvider, Object aSrcValue, Class<DSTTYPE> aDstClass) Convert the passed source value to the destination class, if a conversion is necessary.
static <DSTTYPE> DSTTYPE	convertIfNecessary(Object aSrcValue, Class<DSTTYPE> aDstClass) Convert the passed source value to the destination class, if a conversion is necessary.
static boolean	convertToBoolean(Object aSrcValue) Convert the passed source value to boolean
static byte	convertToByte(Object aSrcValue) Convert the passed source value to byte
static char	convertToChar(Object aSrcValue) Convert the passed source value to char
static double	convertToDouble(Object aSrcValue) Convert the passed source value to double
static float	convertToFloat(Object aSrcValue) Convert the passed source value to float
static int	convertToInt(Object aSrcValue) Convert the passed source value to int
static long	convertToLong(Object aSrcValue) Convert the passed source value to long
static short	convertToShort(Object aSrcValue) Convert the passed source value to short

Methods inherited from class java.lang.Object

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

Method Detail

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(boolean aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(byte aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(char aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(double aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(float aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(int aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(long aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convert

@Nullable
public static <DSTTYPE> DSTTYPE convert(short aSrcValue,
                                 @Nonnull
                                 Class<DSTTYPE> aDstClass)

convertToBoolean

public static boolean convertToBoolean(@Nonnull
                       Object aSrcValue)

Convert the passed source value to boolean

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertToByte

public static byte convertToByte(@Nonnull
                 Object aSrcValue)

Convert the passed source value to byte

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertToChar

public static char convertToChar(@Nonnull
                 Object aSrcValue)

Convert the passed source value to char

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertToDouble

public static double convertToDouble(@Nonnull
                     Object aSrcValue)

Convert the passed source value to double

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertToFloat

public static float convertToFloat(@Nonnull
                   Object aSrcValue)

Convert the passed source value to float

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertToInt

public static int convertToInt(@Nonnull
               Object aSrcValue)

Convert the passed source value to int

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertToLong

public static long convertToLong(@Nonnull
                 Object aSrcValue)

Convert the passed source value to long

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertToShort

public static short convertToShort(@Nonnull
                   Object aSrcValue)

Convert the passed source value to short

Parameters:

aSrcValue - The source value. May not be null.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - if the source value is null

See Also:

TypeConverterProviderBestMatch

convertIfNecessary

@Nullable
public static <DSTTYPE> DSTTYPE convertIfNecessary(@Nullable
                                            Object aSrcValue,
                                            @Nonnull
                                            Class<DSTTYPE> aDstClass)

Convert the passed source value to the destination class, if a conversion is necessary. By default the fuzzy type converter provider is used.

Type Parameters:

DSTTYPE - The destination type.

Parameters:

aSrcValue - The source value. May be null.

aDstClass - The destination class to use.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - If either no converter could be found, or if the conversion failed!

See Also:

TypeConverterProviderBestMatch

convertIfNecessary

@Nullable
public static <DSTTYPE> DSTTYPE convertIfNecessary(@Nonnull
                                            ITypeConverterProvider aTypeConverterProvider,
                                            @Nullable
                                            Object aSrcValue,
                                            @Nonnull
                                            Class<DSTTYPE> aDstClass)
                                  throws TypeConverterException

Convert the passed source value to the destination class, if a conversion is necessary.

Type Parameters:

DSTTYPE - The destination type.

Parameters:

aTypeConverterProvider - The type converter provider. May not be null. .

aSrcValue - The source value. May be null.

aDstClass - The destination class to use.

Returns:

null if the source value was null.

Throws:

IllegalArgumentException - if the conversion process fails because either the conversion failed, or no converter was found.

TypeConverterException - If either no converter could be found, or if the conversion failed!