From 1eef8a722d2b953a1b4b5ebde0efb942ce6db773 Mon Sep 17 00:00:00 2001 From: Keith Donald Date: Sat, 12 Jul 2008 20:19:36 +0000 Subject: [PATCH] javadoc --- .../binding/convert/converters/ObjectToArray.java | 7 +++++++ .../convert/converters/PropertyEditorConverter.java | 9 +++++++++ .../binding/convert/converters/ReverseConverter.java | 7 +++++++ .../binding/mapping/impl/DefaultMapper.java | 2 -- 4 files changed, 23 insertions(+), 2 deletions(-) diff --git a/spring-binding/src/main/java/org/springframework/binding/convert/converters/ObjectToArray.java b/spring-binding/src/main/java/org/springframework/binding/convert/converters/ObjectToArray.java index ee535789..9bbcd310 100644 --- a/spring-binding/src/main/java/org/springframework/binding/convert/converters/ObjectToArray.java +++ b/spring-binding/src/main/java/org/springframework/binding/convert/converters/ObjectToArray.java @@ -20,6 +20,13 @@ import java.lang.reflect.Array; import org.springframework.binding.convert.ConversionExecutor; import org.springframework.binding.convert.ConversionService; +/** + * Special two-way converter that converts an object to an single-element array. Supports type conversion of the + * individual array elements; for example, the ability to convert a String to an Integer[]. Mainly used internally by + * {@link ConversionService} implementations. + * + * @author Keith Donald + */ public class ObjectToArray implements TwoWayConverter { private ConversionService conversionService; diff --git a/spring-binding/src/main/java/org/springframework/binding/convert/converters/PropertyEditorConverter.java b/spring-binding/src/main/java/org/springframework/binding/convert/converters/PropertyEditorConverter.java index 3ee95eea..426151a8 100644 --- a/spring-binding/src/main/java/org/springframework/binding/convert/converters/PropertyEditorConverter.java +++ b/spring-binding/src/main/java/org/springframework/binding/convert/converters/PropertyEditorConverter.java @@ -17,10 +17,19 @@ package org.springframework.binding.convert.converters; import java.beans.PropertyEditor; +/** + * Adapts a PropertyEditor to the {@link TwoWayConverter} interface. + * @author Keith Donald + */ public class PropertyEditorConverter extends StringToObject { private PropertyEditor propertyEditor; + /** + * Creates a new property editor converter. + * @param propertyEditor the property editor to adapt + * @param targetClass the {@link PropertyEditor#getValue() value class} this property editor converts to from string + */ public PropertyEditorConverter(PropertyEditor propertyEditor, Class targetClass) { super(targetClass); this.propertyEditor = propertyEditor; diff --git a/spring-binding/src/main/java/org/springframework/binding/convert/converters/ReverseConverter.java b/spring-binding/src/main/java/org/springframework/binding/convert/converters/ReverseConverter.java index 74dba631..a304cd06 100644 --- a/spring-binding/src/main/java/org/springframework/binding/convert/converters/ReverseConverter.java +++ b/spring-binding/src/main/java/org/springframework/binding/convert/converters/ReverseConverter.java @@ -15,6 +15,13 @@ */ package org.springframework.binding.convert.converters; +/** + * A converter that calls the {@link TwoWayConverter#convertTargetToSourceClass(Object, Class)} on a target + * {@link TwoWayConverter} instance. Useful for invoking the "reverse" (target-to-source) conversion algorithm using the + * standard Converter contract. + * + * @author Keith Donald + */ public class ReverseConverter implements Converter { private TwoWayConverter converter; diff --git a/spring-binding/src/main/java/org/springframework/binding/mapping/impl/DefaultMapper.java b/spring-binding/src/main/java/org/springframework/binding/mapping/impl/DefaultMapper.java index ddd00df0..92c6cb64 100644 --- a/spring-binding/src/main/java/org/springframework/binding/mapping/impl/DefaultMapper.java +++ b/spring-binding/src/main/java/org/springframework/binding/mapping/impl/DefaultMapper.java @@ -21,7 +21,6 @@ import java.util.List; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; -import org.springframework.binding.convert.ConversionService; import org.springframework.binding.mapping.Mapper; import org.springframework.binding.mapping.Mapping; import org.springframework.binding.mapping.MappingResults; @@ -31,7 +30,6 @@ import org.springframework.core.style.ToStringCreator; * Generic mapper implementation that allows mappings to be configured programatically. * * @see #addMapping(DefaultMapping) - * @see #setConversionService(ConversionService) * @author Keith Donald */ public class DefaultMapper implements Mapper {