From 0be647331604e0ac1d14261dff860fcb7b26275a Mon Sep 17 00:00:00 2001 From: Keith Donald Date: Sat, 28 Nov 2009 21:16:01 +0000 Subject: [PATCH] javadoc polishing--named Parser String arg name to 'text' --- .../org/springframework/format/Parser.java | 14 +++++----- .../org/springframework/format/Printer.java | 4 +-- .../format/datetime/DateFormatter.java | 4 +-- .../format/datetime/joda/DateTimeParser.java | 4 +-- .../number/AbstractNumberFormatter.java | 14 +++++----- .../format/number/CurrencyFormatter.java | 4 +-- .../support/FormattingConversionService.java | 26 +++++++------------ 7 files changed, 31 insertions(+), 39 deletions(-) diff --git a/org.springframework.context/src/main/java/org/springframework/format/Parser.java b/org.springframework.context/src/main/java/org/springframework/format/Parser.java index 3312c628354..63e71ba77e1 100644 --- a/org.springframework.context/src/main/java/org/springframework/format/Parser.java +++ b/org.springframework.context/src/main/java/org/springframework/format/Parser.java @@ -20,22 +20,22 @@ import java.text.ParseException; import java.util.Locale; /** - * Parses objects of type T from their printed representations. + * Parses text strings to produce instances of T. * * @author Keith Donald * @since 3.0 - * @param the type of object this Parser parses + * @param the type of object this Parser produces */ public interface Parser { /** - * Parse an object from its printed representation. - * @param printed a printed representation + * Parse a text String to produce a T. + * @param text the text string * @param locale the current user locale - * @return the parsed object + * @return an instance of T * @throws ParseException when a parse exception occurs in a java.text parsing library - * @throws RuntimeException when a parse exception occurs + * @throws IllegalArgumentException when a parse exception occurs */ - T parse(String printed, Locale locale) throws ParseException; + T parse(String text, Locale locale) throws ParseException; } diff --git a/org.springframework.context/src/main/java/org/springframework/format/Printer.java b/org.springframework.context/src/main/java/org/springframework/format/Printer.java index 537d264f74d..00b8c6ec700 100644 --- a/org.springframework.context/src/main/java/org/springframework/format/Printer.java +++ b/org.springframework.context/src/main/java/org/springframework/format/Printer.java @@ -29,9 +29,9 @@ public interface Printer { /** * Print the object of type T for display. - * @param object the object to print + * @param object the instance to print * @param locale the current user locale - * @return the printed string + * @return the printed text string */ String print(T object, Locale locale); diff --git a/org.springframework.context/src/main/java/org/springframework/format/datetime/DateFormatter.java b/org.springframework.context/src/main/java/org/springframework/format/datetime/DateFormatter.java index d41cf7c2357..a371b4cf906 100644 --- a/org.springframework.context/src/main/java/org/springframework/format/datetime/DateFormatter.java +++ b/org.springframework.context/src/main/java/org/springframework/format/datetime/DateFormatter.java @@ -101,8 +101,8 @@ public class DateFormatter implements Formatter { return getDateFormat(locale).format(date); } - public Date parse(String formatted, Locale locale) throws ParseException { - return getDateFormat(locale).parse(formatted); + public Date parse(String text, Locale locale) throws ParseException { + return getDateFormat(locale).parse(text); } diff --git a/org.springframework.context/src/main/java/org/springframework/format/datetime/joda/DateTimeParser.java b/org.springframework.context/src/main/java/org/springframework/format/datetime/joda/DateTimeParser.java index 2c46181cc3c..671084e7991 100644 --- a/org.springframework.context/src/main/java/org/springframework/format/datetime/joda/DateTimeParser.java +++ b/org.springframework.context/src/main/java/org/springframework/format/datetime/joda/DateTimeParser.java @@ -39,7 +39,7 @@ public final class DateTimeParser implements Parser { this.formatter = formatter; } - public DateTime parse(String printed, Locale locale) throws ParseException { - return JodaTimeContextHolder.getFormatter(this.formatter, locale).parseDateTime(printed); + public DateTime parse(String text, Locale locale) throws ParseException { + return JodaTimeContextHolder.getFormatter(this.formatter, locale).parseDateTime(text); } } diff --git a/org.springframework.context/src/main/java/org/springframework/format/number/AbstractNumberFormatter.java b/org.springframework.context/src/main/java/org/springframework/format/number/AbstractNumberFormatter.java index 69644f9d308..63795d6e80e 100644 --- a/org.springframework.context/src/main/java/org/springframework/format/number/AbstractNumberFormatter.java +++ b/org.springframework.context/src/main/java/org/springframework/format/number/AbstractNumberFormatter.java @@ -44,21 +44,21 @@ public abstract class AbstractNumberFormatter implements Formatter { this.lenient = lenient; } - public String print(Number integer, Locale locale) { - return getNumberFormat(locale).format(integer); + public String print(Number number, Locale locale) { + return getNumberFormat(locale).format(number); } - public Number parse(String formatted, Locale locale) throws ParseException { + public Number parse(String text, Locale locale) throws ParseException { NumberFormat format = getNumberFormat(locale); ParsePosition position = new ParsePosition(0); - Number number = format.parse(formatted, position); + Number number = format.parse(text, position); if (position.getErrorIndex() != -1) { - throw new ParseException(formatted, position.getIndex()); + throw new ParseException(text, position.getIndex()); } if (!this.lenient) { - if (formatted.length() != position.getIndex()) { + if (text.length() != position.getIndex()) { // indicates a part of the string that was not parsed - throw new ParseException(formatted, position.getIndex()); + throw new ParseException(text, position.getIndex()); } } return number; diff --git a/org.springframework.context/src/main/java/org/springframework/format/number/CurrencyFormatter.java b/org.springframework.context/src/main/java/org/springframework/format/number/CurrencyFormatter.java index 2c199c9f3ea..417a824cd66 100644 --- a/org.springframework.context/src/main/java/org/springframework/format/number/CurrencyFormatter.java +++ b/org.springframework.context/src/main/java/org/springframework/format/number/CurrencyFormatter.java @@ -75,8 +75,8 @@ public final class CurrencyFormatter extends AbstractNumberFormatter { } - public BigDecimal parse(String formatted, Locale locale) throws ParseException { - BigDecimal decimal = (BigDecimal) super.parse(formatted, locale); + public BigDecimal parse(String text, Locale locale) throws ParseException { + BigDecimal decimal = (BigDecimal) super.parse(text, locale); if (decimal != null) { if (this.roundingMode != null) { decimal = decimal.setScale(this.fractionDigits, this.roundingMode); diff --git a/org.springframework.context/src/main/java/org/springframework/format/support/FormattingConversionService.java b/org.springframework.context/src/main/java/org/springframework/format/support/FormattingConversionService.java index 7f37f3d011b..4b316c72e6c 100644 --- a/org.springframework.context/src/main/java/org/springframework/format/support/FormattingConversionService.java +++ b/org.springframework.context/src/main/java/org/springframework/format/support/FormattingConversionService.java @@ -17,12 +17,10 @@ package org.springframework.format.support; import java.lang.annotation.Annotation; -import java.text.ParseException; import java.util.Set; import org.springframework.context.i18n.LocaleContextHolder; import org.springframework.core.GenericTypeResolver; -import org.springframework.core.convert.ConversionException; import org.springframework.core.convert.ConversionFailedException; import org.springframework.core.convert.ConversionService; import org.springframework.core.convert.TypeDescriptor; @@ -164,27 +162,21 @@ public class FormattingConversionService extends GenericConversionService } public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) { - String submittedValue = (String) source; - if (submittedValue == null || submittedValue.length() == 0) { + String text = (String) source; + if (text == null || text.length() == 0) { return null; } - Object parsedValue; try { - parsedValue = this.parser.parse(submittedValue, LocaleContextHolder.getLocale()); + Object result = this.parser.parse(text, LocaleContextHolder.getLocale()); + TypeDescriptor resultType = TypeDescriptor.valueOf(result.getClass()); + if (!resultType.isAssignableTo(targetType)) { + result = this.conversionService.convert(result, resultType, targetType); + } + return result; } - catch (ParseException ex) { + catch (Exception ex) { throw new ConversionFailedException(sourceType, targetType, source, ex); } - TypeDescriptor parsedObjectType = TypeDescriptor.valueOf(parsedValue.getClass()); - if (!parsedObjectType.isAssignableTo(targetType)) { - try { - parsedValue = this.conversionService.convert(parsedValue, parsedObjectType, targetType); - } - catch (ConversionException ex) { - throw new ConversionFailedException(sourceType, targetType, source, ex); - } - } - return parsedValue; } public String toString() {