root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

javadoc polishing

This commit is contained in:
Keith Donald 2011-06-03 02:01:28 +00:00
parent a8dbac6d8d
commit 08180e97f8
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
org.springframework.core/src/main/java/org/springframework/core/convert/TypeDescriptor.java
View File

@ -37,8 +37,7 @@ import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils; import org.springframework.util.StringUtils;
/** /**
* Context about a type to convert to. * Context about a type to convert from or to.
*
* @author Keith Donald * @author Keith Donald
* @author Andy Clement * @author Andy Clement
* @author Juergen Hoeller * @author Juergen Hoeller
@ -85,8 +84,8 @@ public class TypeDescriptor {
private final Annotation[] annotations; private final Annotation[] annotations;
/** /**
* Create a new type descriptor from a method or constructor parameter. * Create a new type descriptor from a {@link MethodParameter}.
* Use this constructor when a target conversion point is a method parameter. * Use this constructor when a conversion point is a constructor parameter, method parameter, or method return value.
* @param methodParameter the method parameter * @param methodParameter the method parameter
*/ */
public TypeDescriptor(MethodParameter methodParameter) { public TypeDescriptor(MethodParameter methodParameter) {
@ -95,7 +94,7 @@ public class TypeDescriptor {
/** /**
* Create a new type descriptor for a field. * Create a new type descriptor for a field.
* Use this constructor when a target conversion point is a field. * Use this constructor when a conversion point is a field.
* @param field the field * @param field the field
*/ */
public TypeDescriptor(Field field) { public TypeDescriptor(Field field) {
@ -155,8 +154,8 @@ public class TypeDescriptor {
/** /**
* Create a new type descriptor for an object. * Create a new type descriptor for an object.
* Use this factory method to introspect a source object's type before asking the conversion system to convert it to some another type. * Use this factory method to introspect a source object's type before asking the conversion system to convert it to some another type.
* Builds in population of nested type descriptors for collection and map objects through object introspection. * Populates nested type descriptors for collection and map objects through object introspection.
* If the object is null, returns {@link TypeDescriptor#NULL}. * If the provided object is null, returns {@link TypeDescriptor#NULL}.
* If the object is not a collection or map, simply calls {@link #valueOf(Class)}. * If the object is not a collection or map, simply calls {@link #valueOf(Class)}.
* If the object is a collection or map, this factory method will derive nested element or key/value types by introspecting the collection or map. * If the object is a collection or map, this factory method will derive nested element or key/value types by introspecting the collection or map.
* The introspection algorithm derives nested element or key/value types by resolving the "common element type" across the collection or map. * The introspection algorithm derives nested element or key/value types by resolving the "common element type" across the collection or map.