org.springframework.core.convert.support

Class ObjectToObjectConverter

java.lang.Object

org.springframework.core.convert.support.ObjectToObjectConverter

All Implemented Interfaces:

ConditionalConverter, ConditionalGenericConverter, GenericConverter

final class ObjectToObjectConverter
extends java.lang.Object
implements ConditionalGenericConverter

Generic converter that uses conventions to convert a source object to a targetType by delegating to a method on the source object or to a static factory method or constructor on the targetType.

Conversion Algorithm

1. Invoke a non-static to[targetType.simpleName]() method on the source object that has a return type equal to targetType, if such a method exists. For example, org.example.Bar Foo#toBar() is a method that follows this convention.
2. Otherwise invoke a static valueOf(sourceType) or Java 8 style static of(sourceType) or from(sourceType) method on the targetType, if such a method exists.
3. Otherwise invoke a constructor on the targetType that accepts a single sourceType argument, if such a constructor exists.
4. Otherwise throw a ConversionFailedException.

Warning: this converter does not support the Object.toString() method for converting from a sourceType to java.lang.String. For toString() support, use FallbackObjectToStringConverter instead.

Since:

3.0

Author:

Keith Donald, Juergen Hoeller, Sam Brannen

See Also:

FallbackObjectToStringConverter

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.core.convert.converter.GenericConverter

GenericConverter.ConvertiblePair

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.Class<?>,java.lang.reflect.Member>	conversionMemberCache

Constructor Summary

Constructors

Constructor and Description
ObjectToObjectConverter()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convert(java.lang.Object source, TypeDescriptor sourceType, TypeDescriptor targetType) Convert the source object to the targetType described by the TypeDescriptor.
private static java.lang.reflect.Constructor<?>	determineFactoryConstructor(java.lang.Class<?> targetClass, java.lang.Class<?> sourceClass)
private static java.lang.reflect.Method	determineFactoryMethod(java.lang.Class<?> targetClass, java.lang.Class<?> sourceClass)
private static java.lang.reflect.Method	determineToMethod(java.lang.Class<?> targetClass, java.lang.Class<?> sourceClass)
java.util.Set<GenericConverter.ConvertiblePair>	getConvertibleTypes() Return the source and target types that this converter can convert between.
private static java.lang.reflect.Member	getValidatedMember(java.lang.Class<?> targetClass, java.lang.Class<?> sourceClass)
(package private) static boolean	hasConversionMethodOrConstructor(java.lang.Class<?> targetClass, java.lang.Class<?> sourceClass)
private static boolean	isApplicable(java.lang.reflect.Member member, java.lang.Class<?> sourceClass)
boolean	matches(TypeDescriptor sourceType, TypeDescriptor targetType) Should the conversion from sourceType to targetType currently under consideration be selected?

Methods inherited from class java.lang.Object

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

Field Detail

conversionMemberCache

private static final java.util.Map<java.lang.Class<?>,java.lang.reflect.Member> conversionMemberCache

Constructor Detail

ObjectToObjectConverter

ObjectToObjectConverter()

Method Detail

getConvertibleTypes

public java.util.Set<GenericConverter.ConvertiblePair> getConvertibleTypes()

Description copied from interface: GenericConverter

Return the source and target types that this converter can convert between.

Each entry is a convertible source-to-target type pair.

For conditional converters this method may return null to indicate all source-to-target pairs should be considered.

Specified by:

getConvertibleTypes in interface GenericConverter

matches

public boolean matches(TypeDescriptor sourceType,
                       TypeDescriptor targetType)

Description copied from interface: ConditionalConverter

Should the conversion from sourceType to targetType currently under consideration be selected?

Specified by:

matches in interface ConditionalConverter

Parameters:

sourceType - the type descriptor of the field we are converting from

targetType - the type descriptor of the field we are converting to

Returns:

true if conversion should be performed, false otherwise

convert

public java.lang.Object convert(java.lang.Object source,
                                TypeDescriptor sourceType,
                                TypeDescriptor targetType)

Description copied from interface: GenericConverter

Convert the source object to the targetType described by the TypeDescriptor.

Specified by:

convert in interface GenericConverter

Parameters:

source - the source object to convert (may be null)

sourceType - the type descriptor of the field we are converting from

targetType - the type descriptor of the field we are converting to

Returns:

the converted object

hasConversionMethodOrConstructor

static boolean hasConversionMethodOrConstructor(java.lang.Class<?> targetClass,
                                                java.lang.Class<?> sourceClass)

getValidatedMember

private static java.lang.reflect.Member getValidatedMember(java.lang.Class<?> targetClass,
                                                           java.lang.Class<?> sourceClass)

isApplicable

private static boolean isApplicable(java.lang.reflect.Member member,
                                    java.lang.Class<?> sourceClass)

determineToMethod

private static java.lang.reflect.Method determineToMethod(java.lang.Class<?> targetClass,
                                                          java.lang.Class<?> sourceClass)

determineFactoryMethod

private static java.lang.reflect.Method determineFactoryMethod(java.lang.Class<?> targetClass,
                                                               java.lang.Class<?> sourceClass)

determineFactoryConstructor

private static java.lang.reflect.Constructor<?> determineFactoryConstructor(java.lang.Class<?> targetClass,
                                                                            java.lang.Class<?> sourceClass)