public interface ConversionService
convert(Object, Class)
to perform a thread-safe type conversion using this system.Modifier and Type | Method and Description |
---|---|
boolean |
canConvert(Class<?> sourceType,
Class<?> targetType)
Return
true if objects of sourceType can be converted to the targetType . |
boolean |
canConvert(TypeDescriptor sourceType,
TypeDescriptor targetType)
Return
true if objects of sourceType can be converted to the targetType . |
<T> T |
convert(Object source,
Class<T> targetType)
Convert the given
source to the specified targetType . |
Object |
convert(Object source,
TypeDescriptor sourceType,
TypeDescriptor targetType)
Convert the given
source to the specified targetType . |
boolean canConvert(@Nullable Class<?> sourceType, Class<?> targetType)
true
if objects of sourceType
can be converted to the targetType
.
If this method returns true
, it means convert(Object, Class)
is capable
of converting an instance of sourceType
to targetType
.
Special note on collections, arrays, and maps types:
For conversion between collection, array, and map types, this method will return true
even though a convert invocation may still generate a ConversionException
if the
underlying elements are not convertible. Callers are expected to handle this exceptional case
when working with collections and maps.
sourceType
- the source type to convert from (may be null
if source is null
)targetType
- the target type to convert to (required)true
if a conversion can be performed, false
if notIllegalArgumentException
- if targetType
is null
boolean canConvert(@Nullable TypeDescriptor sourceType, TypeDescriptor targetType)
true
if objects of sourceType
can be converted to the targetType
.
The TypeDescriptors provide additional context about the source and target locations
where conversion would occur, often object fields or property locations.
If this method returns true
, it means convert(Object, TypeDescriptor, TypeDescriptor)
is capable of converting an instance of sourceType
to targetType
.
Special note on collections, arrays, and maps types:
For conversion between collection, array, and map types, this method will return true
even though a convert invocation may still generate a ConversionException
if the
underlying elements are not convertible. Callers are expected to handle this exceptional case
when working with collections and maps.
sourceType
- context about the source type to convert from
(may be null
if source is null
)targetType
- context about the target type to convert to (required)true
if a conversion can be performed between the source and target types,
false
if notIllegalArgumentException
- if targetType
is null
@Nullable <T> T convert(@Nullable Object source, Class<T> targetType)
source
to the specified targetType
.source
- the source object to convert (may be null
)targetType
- the target type to convert to (required)ConversionException
- if a conversion exception occurredIllegalArgumentException
- if targetType is null
@Nullable Object convert(@Nullable Object source, @Nullable TypeDescriptor sourceType, TypeDescriptor targetType)
source
to the specified targetType
.
The TypeDescriptors provide additional context about the source and target locations
where conversion will occur, often object fields or property locations.source
- the source object to convert (may be null
)sourceType
- context about the source type to convert from
(may be null
if source is null
)targetType
- context about the target type to convert to (required)targetType
ConversionException
- if a conversion exception occurredIllegalArgumentException
- if targetType is null
,
or sourceType
is null
but source is not null