Return-Path: Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: (qmail 79766 invoked from network); 5 Dec 2010 19:55:04 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 5 Dec 2010 19:55:04 -0000 Received: (qmail 16899 invoked by uid 500); 5 Dec 2010 19:55:04 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 16815 invoked by uid 500); 5 Dec 2010 19:55:04 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 16808 invoked by uid 99); 5 Dec 2010 19:55:04 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 05 Dec 2010 19:55:04 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 05 Dec 2010 19:55:01 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id C9A32238899C; Sun, 5 Dec 2010 19:54:41 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1042430 - in /commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert: GenericSingletonToList.java GenericSingletonToSet.java GenericToStringConverter.java MiscConverters.java NetConverters.java NumberConverters.java Util.java Date: Sun, 05 Dec 2010 19:54:41 -0000 To: commits@commons.apache.org From: adrianc@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20101205195441.C9A32238899C@eris.apache.org> Author: adrianc Date: Sun Dec 5 19:54:41 2010 New Revision: 1042430 URL: http://svn.apache.org/viewvc?rev=1042430&view=rev Log: Second pass at building out JavaDocs. Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToList.java commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToSet.java commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericToStringConverter.java commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/MiscConverters.java commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NetConverters.java commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NumberConverters.java commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Util.java Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToList.java URL: http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToList.java?rev=1042430&r1=1042429&r2=1042430&view=diff ============================================================================== --- commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToList.java (original) +++ commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToList.java Sun Dec 5 19:54:41 2010 @@ -21,6 +21,10 @@ package org.apache.commons.convert; import java.util.ArrayList; import java.util.List; +/** + * An object that creates a List and adds an object to the + * List. + */ public class GenericSingletonToList extends AbstractConverter> { public GenericSingletonToList(Class sourceClass) { super(sourceClass, List.class); Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToSet.java URL: http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToSet.java?rev=1042430&r1=1042429&r2=1042430&view=diff ============================================================================== --- commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToSet.java (original) +++ commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericSingletonToSet.java Sun Dec 5 19:54:41 2010 @@ -21,6 +21,10 @@ package org.apache.commons.convert; import java.util.HashSet; import java.util.Set; +/** + * An object that creates a Set and adds an object to the + * Set. + */ public class GenericSingletonToSet extends AbstractConverter> { public GenericSingletonToSet(Class sourceClass) { super(sourceClass, Set.class); Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericToStringConverter.java URL: http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericToStringConverter.java?rev=1042430&r1=1042429&r2=1042430&view=diff ============================================================================== --- commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericToStringConverter.java (original) +++ commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/GenericToStringConverter.java Sun Dec 5 19:54:41 2010 @@ -18,7 +18,10 @@ *******************************************************************************/ package org.apache.commons.convert; -/** Generic object-to-string converter class. */ +/** + * An object that converts any object to a String + * by calling the object's toString method.. + */ public class GenericToStringConverter extends AbstractConverter { public GenericToStringConverter(Class sourceClass) { Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/MiscConverters.java URL: http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/MiscConverters.java?rev=1042430&r1=1042429&r2=1042430&view=diff ============================================================================== --- commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/MiscConverters.java (original) +++ commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/MiscConverters.java Sun Dec 5 19:54:41 2010 @@ -41,6 +41,10 @@ public class MiscConverters implements C Converters.registerConverter(new GenericToStringConverter(Pattern.class)); } + /** + * An object that converts a java.sql.Blob to a + * byte array. + */ public static class BlobToByteArray extends AbstractConverter { public BlobToByteArray() { super(Blob.class, byte[].class); @@ -86,6 +90,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a byte array to a + * ByteBuffer. + */ public static class ByteArrayToByteBuffer extends AbstractConverter { public ByteArrayToByteBuffer() { super(byte[].class, ByteBuffer.class); @@ -100,6 +108,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a ByteBuffer to a + * byte array. + */ public static class ByteBufferToByteArray extends AbstractConverter { public ByteBufferToByteArray() { super(ByteBuffer.class, byte[].class); @@ -114,6 +126,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a Charset to a + * character set name String. + */ public static class CharsetToString extends AbstractConverter { public CharsetToString() { super(Charset.class, String.class); @@ -124,6 +140,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a java.sql.Clob to a + * String. + */ public static class ClobToString extends AbstractConverter { public ClobToString() { super(Clob.class, String.class); @@ -155,6 +175,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a DecimalFormat to a + * format pattern String. + */ public static class DecimalFormatToString extends AbstractConverter { public DecimalFormatToString() { super(DecimalFormat.class, String.class); @@ -187,12 +211,20 @@ public class MiscConverters implements C } } + /** + * A class used for testing ConverterLoader + * implementations. + */ public static class NotAConverter { protected NotAConverter() { throw new Error("Should not be loaded"); } } + /** + * An object that converts a SimpleDateFormat to a + * format pattern String. + */ public static class SimpleDateFormatToString extends AbstractConverter { public SimpleDateFormatToString() { super(SimpleDateFormat.class, String.class); @@ -203,6 +235,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a character set name String to a + * Charset. + */ public static class StringToCharset extends AbstractConverter { public StringToCharset() { super(String.class, Charset.class); @@ -227,6 +263,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a format pattern String to a + * DecimalFormat. + */ public static class StringToDecimalFormat extends AbstractConverter { public StringToDecimalFormat() { super(String.class, DecimalFormat.class); @@ -273,6 +313,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a Locale ID + * String to a Locale. + */ public static class StringToLocale extends AbstractConverter { public StringToLocale() { super(String.class, Locale.class); @@ -283,6 +327,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a pattern String to a + * Pattern. + */ public static class StringToRegexPattern extends AbstractConverter { public StringToRegexPattern() { super(String.class, Pattern.class); @@ -293,6 +341,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a format String to a + * SimpleDateFormat. + */ public static class StringToSimpleDateFormat extends AbstractConverter { public StringToSimpleDateFormat() { super(String.class, SimpleDateFormat.class); @@ -303,6 +355,10 @@ public class MiscConverters implements C } } + /** + * An object that converts a UUID String to a + * UUID. + */ public static class StringToUUID extends AbstractConverter { public StringToUUID() { super(String.class, UUID.class); Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NetConverters.java URL: http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NetConverters.java?rev=1042430&r1=1042429&r2=1042430&view=diff ============================================================================== --- commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NetConverters.java (original) +++ commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NetConverters.java Sun Dec 5 19:54:41 2010 @@ -25,7 +25,7 @@ import java.net.URI; import java.net.URISyntaxException; import java.net.URL; -/** Net Converter classes. */ +/** java.net Converter classes. */ public class NetConverters implements ConverterLoader { public void loadConverters() { @@ -40,6 +40,10 @@ public class NetConverters implements Co Converters.registerConverter(new GenericSingletonToSet(URL.class)); } + /** + * An object that converts an InetAddress to a + * String. + */ public static class InetAddressToString extends AbstractConverter { public InetAddressToString() { super(InetAddress.class, String.class); @@ -52,6 +56,10 @@ public class NetConverters implements Co } } + /** + * An object that converts a String to an + * InetAddress. + */ public static class StringToInetAddress extends AbstractConverter { public StringToInetAddress() { super(String.class, InetAddress.class); @@ -66,6 +74,10 @@ public class NetConverters implements Co } } + /** + * An object that converts a String to a + * URI. + */ public static class StringToURI extends AbstractConverter { public StringToURI() { super(String.class, URI.class); @@ -80,6 +92,10 @@ public class NetConverters implements Co } } + /** + * An object that converts a String to a + * URL. + */ public static class StringToURL extends AbstractConverter { public StringToURL() { super(String.class, URL.class); @@ -94,6 +110,10 @@ public class NetConverters implements Co } } + /** + * An object that converts a URI to a + * URL. + */ public static class URIToURL extends AbstractConverter { public URIToURL() { super(URI.class, URL.class); @@ -108,6 +128,10 @@ public class NetConverters implements Co } } + /** + * An object that converts a URL to a + * URI. + */ public static class URLToURI extends AbstractConverter { public URLToURI() { super(URL.class, URI.class); Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NumberConverters.java URL: http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NumberConverters.java?rev=1042430&r1=1042429&r2=1042430&view=diff ============================================================================== --- commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NumberConverters.java (original) +++ commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/NumberConverters.java Sun Dec 5 19:54:41 2010 @@ -72,6 +72,10 @@ public class NumberConverters implements } } + /** + * An abstract Number to String converter class + * that implements some of the LocalizedConverter methods. + */ public static abstract class AbstractNumberToStringConverter extends AbstractNumberConverter { public AbstractNumberToStringConverter(Class sourceClass) { super(sourceClass, String.class); @@ -88,6 +92,10 @@ public class NumberConverters implements protected abstract String format(N obj, NumberFormat nf) throws ConversionException; } + /** + * An abstract String to Number converter class + * that implements some of the LocalizedConverter methods. + */ public static abstract class AbstractStringToNumberConverter extends AbstractNumberConverter { public AbstractStringToNumberConverter(Class targetClass) { super(String.class, targetClass); @@ -100,6 +108,10 @@ public class NumberConverters implements } } + /** + * An object that converts a BigDecimal to a + * String. + */ public static class BigDecimalToString extends AbstractNumberToStringConverter { public BigDecimalToString() { super(BigDecimal.class); @@ -110,6 +122,10 @@ public class NumberConverters implements } } + /** + * An object that converts a BigInteger to a + * String. + */ public static class BigIntegerToString extends AbstractNumberToStringConverter { public BigIntegerToString() { super(BigInteger.class); @@ -120,6 +136,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Byte to a + * String. + */ public static class ByteToString extends AbstractNumberToStringConverter { public ByteToString() { super(Byte.class); @@ -140,6 +160,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Double to a + * String. + */ public static class DoubleToString extends AbstractNumberToStringConverter { public DoubleToString() { super(Double.class); @@ -160,6 +184,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Float to a + * String. + */ public static class FloatToString extends AbstractNumberToStringConverter { public FloatToString() { super(Float.class); @@ -170,6 +198,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to a + * BigDecimal. + */ public static class GenericNumberToBigDecimal extends AbstractConverter { public GenericNumberToBigDecimal(Class sourceClass) { super(sourceClass, BigDecimal.class); @@ -180,6 +212,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to a + * BigInteger. + */ public static class GenericNumberToBigInteger extends AbstractConverter { public GenericNumberToBigInteger(Class sourceClass) { super(sourceClass, BigInteger.class); @@ -190,6 +226,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to a + * Byte. + */ public static class GenericNumberToByte extends AbstractConverter { public GenericNumberToByte(Class sourceClass) { super(sourceClass, Byte.class); @@ -200,6 +240,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to a + * Double. + */ public static class GenericNumberToDouble extends AbstractConverter { public GenericNumberToDouble(Class sourceClass) { super(sourceClass, Double.class); @@ -210,6 +254,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to a + * Float. + */ public static class GenericNumberToFloat extends AbstractConverter { public GenericNumberToFloat(Class sourceClass) { super(sourceClass, Float.class); @@ -220,6 +268,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to an + * Integer. + */ public static class GenericNumberToInteger extends AbstractConverter { public GenericNumberToInteger(Class sourceClass) { super(sourceClass, Integer.class); @@ -230,6 +282,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to a + * Long. + */ public static class GenericNumberToLong extends AbstractConverter { public GenericNumberToLong(Class sourceClass) { super(sourceClass, Long.class); @@ -240,6 +296,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Number to a + * Short. + */ public static class GenericNumberToShort extends AbstractConverter { public GenericNumberToShort(Class sourceClass) { super(sourceClass, Short.class); @@ -270,6 +330,10 @@ public class NumberConverters implements } } + /** + * An object that converts an Integer to a + * String. + */ public static class IntegerToString extends AbstractNumberToStringConverter { public IntegerToString() { super(Integer.class); @@ -280,6 +344,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Long to a + * BigDecimal. + */ public static class LongToBigDecimal extends AbstractConverter { public LongToBigDecimal() { super(Long.class, BigDecimal.class); @@ -300,6 +368,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Long to a + * String. + */ public static class LongToString extends AbstractNumberToStringConverter { public LongToString() { super(Long.class); @@ -310,6 +382,10 @@ public class NumberConverters implements } } + /** + * An object that converts a Short to a + * String. + */ public static class ShortToString extends AbstractNumberToStringConverter { public ShortToString() { super(Short.class); @@ -320,6 +396,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to a + * BigDecimal. + */ public static class StringToBigDecimal extends AbstractStringToNumberConverter { public StringToBigDecimal() { super(BigDecimal.class); @@ -334,6 +414,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to a + * BigInteger. + */ public static class StringToBigInteger extends AbstractStringToNumberConverter { public StringToBigInteger() { super(BigInteger.class); @@ -348,6 +432,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to a + * Byte. + */ public static class StringToByte extends AbstractConverter { public StringToByte() { super(String.class, Byte.class); @@ -358,6 +446,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to a + * Double. + */ public static class StringToDouble extends AbstractStringToNumberConverter { public StringToDouble() { super(Double.class); @@ -372,6 +464,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to a + * Float. + */ public static class StringToFloat extends AbstractStringToNumberConverter { public StringToFloat() { super(Float.class); @@ -386,6 +482,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to an + * Integer. + */ public static class StringToInteger extends AbstractStringToNumberConverter { public StringToInteger() { super(Integer.class); @@ -400,6 +500,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to a + * Long. + */ public static class StringToLong extends AbstractStringToNumberConverter { public StringToLong() { super(Long.class); @@ -414,6 +518,10 @@ public class NumberConverters implements } } + /** + * An object that converts a String to a + * Short. + */ public static class StringToShort extends AbstractConverter { public StringToShort() { super(String.class, Short.class); Modified: commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Util.java URL: http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Util.java?rev=1042430&r1=1042429&r2=1042430&view=diff ============================================================================== --- commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Util.java (original) +++ commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Util.java Sun Dec 5 19:54:41 2010 @@ -33,7 +33,8 @@ public class Util { } /** - * Tests if a class is a class of a sub-class of or properly implements an interface. + * Tests if a class is a sub-class of typeClass or + * if a class properly implements an interface. * @param objectClass Class to test * @param typeClass Class to test against * @return true if objectClass is a class or sub-class of, or implements typeClass