diff --git a/spring-core/src/main/java/org/springframework/core/convert/ConversionService.java b/spring-core/src/main/java/org/springframework/core/convert/ConversionService.java index 84756278b21..75f9a276c70 100644 --- a/spring-core/src/main/java/org/springframework/core/convert/ConversionService.java +++ b/spring-core/src/main/java/org/springframework/core/convert/ConversionService.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2012 the original author or authors. + * Copyright 2002-2013 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -27,36 +27,43 @@ package org.springframework.core.convert; public interface ConversionService { /** - * Returns true if objects of sourceType can be converted to targetType. - * If this method returns true, it means {@link #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 {@link ConversionException} if the underlying elements are not convertible. - * Callers are expected to handle this exceptional case when working with collections and maps. - * @param sourceType the source type to convert from (may be null if source is null) + * Return {@code true} if objects of {@code sourceType} can be converted to the {@code targetType}. + *
If this method returns {@code true}, it means {@link #convert(Object, Class)} is capable + * of converting an instance of {@code sourceType} to {@code targetType}. + *
Special note on collections, arrays, and maps types: + * For conversion between collection, array, and map types, this method will return {@code true} + * even though a convert invocation may still generate a {@link ConversionException} if the + * underlying elements are not convertible. Callers are expected to handle this exceptional case + * when working with collections and maps. + * @param sourceType the source type to convert from (may be {@code null} if source is {@code null}) * @param targetType the target type to convert to (required) - * @return true if a conversion can be performed, false if not - * @throws IllegalArgumentException if targetType is null + * @return {@code true} if a conversion can be performed, {@code false} if not + * @throws IllegalArgumentException if {@code targetType} is {@code null} */ boolean canConvert(Class> sourceType, Class> targetType); /** - * Returns 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 {@link #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 {@link ConversionException} if the underlying elements are not convertible. - * Callers are expected to handle this exceptional case when working with collections and maps. - * @param sourceType context about the source type to convert from (may be null if source is null) + * Return {@code true} if objects of {@code sourceType} can be converted to the {@code 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 {@code true}, it means {@link #convert(Object, TypeDescriptor, TypeDescriptor)} + * is capable of converting an instance of {@code sourceType} to {@code targetType}. + *
Special note on collections, arrays, and maps types:
+ * For conversion between collection, array, and map types, this method will return {@code true}
+ * even though a convert invocation may still generate a {@link ConversionException} if the
+ * underlying elements are not convertible. Callers are expected to handle this exceptional case
+ * when working with collections and maps.
+ * @param sourceType context about the source type to convert from
+ * (may be {@code null} if source is {@code null})
* @param targetType context about the target type to convert to (required)
- * @return true if a conversion can be performed between the source and target types, false if not
- * @throws IllegalArgumentException if targetType is null
+ * @return {@code true} if a conversion can be performed between the source and target types,
+ * {@code false} if not
+ * @throws IllegalArgumentException if {@code targetType} is {@code null}
*/
boolean canConvert(TypeDescriptor sourceType, TypeDescriptor targetType);
/**
- * Convert the source to targetType.
+ * Convert the given {@code source} to the specified {@code targetType}.
* @param source the source object to convert (may be null)
* @param targetType the target type to convert to (required)
* @return the converted object, an instance of targetType
@@ -66,15 +73,17 @@ public interface ConversionService {