Author: ehillenius
Date: Thu Apr 5 15:36:59 2007
New Revision: 525986
URL: http://svn.apache.org/viewvc?view=rev&rev=525986
Log:
fixes for JavaDocs and removed unused/ unneeded classes
Removed:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverterFactory.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ILocalizable.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ITypeConverter.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/LocalizableAdapter.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/SimpleConverterAdapter.java
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/IConverterLocator.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocator.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocatorFactory.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverter.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverterLocatorFactory.java
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/MaskConverter.java
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/IConverterLocator.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/IConverterLocator.java?view=diff&rev=525986&r1=525985&r2=525986
==============================================================================
---
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/IConverterLocator.java
(original)
+++
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/IConverterLocator.java
Thu Apr 5 15:36:59 2007
@@ -16,18 +16,21 @@
*/
package wicket;
+import wicket.settings.IApplicationSettings;
import wicket.util.convert.ConverterLocator;
import wicket.util.convert.IConverter;
+import wicket.util.convert.IConverterLocatorFactory;
/**
- * A Class who implement this interface must return the right converter for the
- * given class type.
+ * Locates the proper converter instance for a given type. Classes that
+ * implement this interface must return the right converter for the given class
+ * type. Instances are created by [EMAIL PROTECTED] IConverterLocatorFactory},
which can
+ * be configured using [EMAIL PROTECTED]
IApplicationSettings#getConverterLocatorFactory()}.
*
- * @author jcompagner
- *
- * @see Component
- * @see Session
* @see ConverterLocator
+ * @see IConverterLocatorFactory
+ *
+ * @author jcompagner
*/
public interface IConverterLocator extends IClusterable
{
@@ -38,5 +41,5 @@
* @param type
* @return The converter for the given type.
*/
- public IConverter getConverter(Class/*<?>*/ type);
+ public IConverter getConverter(Class/* <?> */type);
}
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocator.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocator.java?view=diff&rev=525986&r1=525985&r2=525986
==============================================================================
---
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocator.java
(original)
+++
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocator.java
Thu Apr 5 15:36:59 2007
@@ -37,33 +37,9 @@
import wicket.util.lang.Objects;
/**
- * Implementation of IConverter interface, which converts objects from one
class
- * to another. This class allows specific type converters implementing the
- * ITypeConverter interface to be registered as conversion operations for
- * specific types. By default this class registers type converters for Date,
- * String and all Java primitive types and their wrapper classes.
- * <p>
- * To convert from a Double value to a String value you can use the generalized
- * converter interface:
- *
- * <pre>
- * final IConverter converter = new CoverterLocatorFactory().newConverter();
- * converter.setLocale(Locale.US);
- * converter.convert(new Double(7.1), String.class);
- * </pre>
- *
- * Or this can be accomplished by directly using the StringConverter type
- * conversion class (which is registered as a type converter on the IConverter
- * returned by the converter factory above).
- *
- * <pre>
- * final StringConverter converter = new StringConverter(Locale.US);
- * converter.convert(new Double(7.1));
- * </pre>
- *
- * When using Wicket, you should rarely need to use any of the conversion
- * classes directly. There are convenient validators and conversion features
- * built into Wicket that you can use directly.
+ * Implementation of [EMAIL PROTECTED] IConverterLocator} interface, which
locates
+ * converters for a given type. It serves as a registry for [EMAIL PROTECTED]
IConverter}
+ * instances stored by type, and is the default locator for Wicket.
*
* @see IConverterLocatorFactory
* @author Eelco Hillenius
@@ -71,30 +47,25 @@
*/
public class ConverterLocator implements IConverterLocator
{
- private static final long serialVersionUID = 1L;
-
- /** Maps Classes to ITypeConverters. */
- private final Map/*Class<?>, IConverter*/ classToConverter = new
HashMap/*Class<?>, IConverter*/();
-
/**
* CoverterLocator that is to be used when no registered converter is
found.
*/
private class DefaultConverter implements IConverter
{
- private Class/*?*/ type;
+ private static final long serialVersionUID = 1L;
+
+ private Class/* ? */type;
/**
* Construct.
*
* @param type
*/
- public DefaultConverter(Class/*?*/ type)
+ public DefaultConverter(Class/* ? */type)
{
this.type = type;
}
- private static final long serialVersionUID = 1L;
-
/**
* @see
wicket.util.convert.IConverter#convertToObject(java.lang.String,
* java.util.Locale)
@@ -137,7 +108,15 @@
return (String)Objects.convertValue(value,
String.class);
}
- };
+ }
+
+ private static final long serialVersionUID = 1L;
+
+ /** Maps Classes to ITypeConverters. */
+ private final Map/* Class<?>, IConverter */classToConverter = new
HashMap/*
+
* Class<?>,
+
* IConverter
+
*/();;
/**
* Constructor
@@ -167,6 +146,19 @@
}
/**
+ * Gets the type converter that is registered for class c.
+ *
+ * @param c
+ * The class to get the type converter for
+ * @return The type converter that is registered for class c or null if
no
+ * type converter was registered for class c
+ */
+ public final IConverter get(Class/* ? */c)
+ {
+ return (IConverter)classToConverter.get(c);
+ }
+
+ /**
* Converts the given value to class c.
*
* @param type
@@ -196,19 +188,6 @@
}
/**
- * Gets the type converter that is registered for class c.
- *
- * @param c
- * The class to get the type converter for
- * @return The type converter that is registered for class c or null if
no
- * type converter was registered for class c
- */
- public final IConverter get(Class/*?*/ c)
- {
- return (IConverter)classToConverter.get(c);
- }
-
- /**
* Removes the type converter currently registered for class c.
*
* @param c
@@ -217,7 +196,7 @@
* @return The converter that was registered for class c before removal
or
* null if none was registered
*/
- public final IConverter remove(Class/*?*/ c)
+ public final IConverter remove(Class/* ? */c)
{
return (IConverter)classToConverter.remove(c);
}
@@ -232,7 +211,7 @@
* @return The previous registered converter for class c or null if
none was
* registered yet for class c
*/
- public final IConverter set(final Class/*?*/ c, final IConverter
converter)
+ public final IConverter set(final Class/* ? */c, final IConverter
converter)
{
if (converter == null)
{
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocatorFactory.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocatorFactory.java?view=diff&rev=525986&r1=525985&r2=525986
==============================================================================
---
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocatorFactory.java
(original)
+++
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/ConverterLocatorFactory.java
Thu Apr 5 15:36:59 2007
@@ -19,8 +19,8 @@
import wicket.IConverterLocator;
/**
- * Implementation of [EMAIL PROTECTED] IConverterLocatorFactory}which creates
- * an instance of [EMAIL PROTECTED] IConverterLocator}.
+ * Implementation of [EMAIL PROTECTED] IConverterLocatorFactory} which creates
an instance
+ * of [EMAIL PROTECTED] IConverterLocator}.
*
* @author Eelco Hillenius
* @author Jonathan Locke
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverter.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverter.java?view=diff&rev=525986&r1=525985&r2=525986
==============================================================================
---
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverter.java
(original)
+++
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverter.java
Thu Apr 5 15:36:59 2007
@@ -16,13 +16,25 @@
*/
package wicket.util.convert;
+import java.util.Date;
import java.util.Locale;
import wicket.IClusterable;
/**
- * General purpose data type converter. An object that implements this
interface
- * can convert objects from one class to another.
+ * Converts input to output and vice versa. Converters are needed in web
+ * applications because we have to switch between Java objects on the server
and
+ * Strings in the browser output and input.
+ * <p>
+ * Output conversion, which is handled by
+ * [EMAIL PROTECTED] #convertToString(Object, Locale)}, is typically used by
components
+ * when they render, so that a date can be displayed as '12/12/2007'. Input
+ * conversion, handled by [EMAIL PROTECTED] #convertToObject(String, Locale)},
is
+ * typically used by form components to interpret incoming values Such values
+ * are strings as they are send as request parameters from browsers. An
incoming
+ * value could be the string '12/12/2007' which could be translated to a
+ * corresponding [EMAIL PROTECTED] Date} object.
+ * </p>
*
* @author Eelco Hillenius
* @author Jonathan Locke
@@ -46,7 +58,7 @@
* @param value
* The value to convert
* @param locale
- * TODO
+ * The locale used to convert the value
*
* @return The converted string value
*/
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverterLocatorFactory.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverterLocatorFactory.java?view=diff&rev=525986&r1=525985&r2=525986
==============================================================================
---
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverterLocatorFactory.java
(original)
+++
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/IConverterLocatorFactory.java
Thu Apr 5 15:36:59 2007
@@ -17,9 +17,14 @@
package wicket.util.convert;
import wicket.IConverterLocator;
+import wicket.settings.IApplicationSettings;
/**
* Factory that creates and configures instances of [EMAIL PROTECTED]
IConverterLocator}.
+ * The actual instance to use can be configured using
+ * [EMAIL PROTECTED] IApplicationSettings#getConverterLocatorFactory()}.
+ *
+ * @see ConverterLocatorFactory
*
* @author Eelco Hillenius
* @author Jonathan Locke
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/MaskConverter.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/MaskConverter.java?view=diff&rev=525986&r1=525985&r2=525986
==============================================================================
---
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/MaskConverter.java
(original)
+++
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/wicket/util/convert/MaskConverter.java
Thu Apr 5 15:36:59 2007
@@ -27,8 +27,8 @@
/**
* A converter that takes a mask into account. It is specifically meant for
* overrides on individual components, that provide their own converter by
- * returning it from [EMAIL PROTECTED] Component#getConverter(Object)}. It
uses an
- * instance of [EMAIL PROTECTED] MaskFormatter} to delegate the masking and
unmasking to.
+ * returning it from [EMAIL PROTECTED] Component#getConverter(Class)}. It uses
an instance
+ * of [EMAIL PROTECTED] MaskFormatter} to delegate the masking and unmasking
to.
* <p>
* The following characters can be specified (adopted from the MaskFormatter
* documentation):
@@ -134,7 +134,7 @@
* The type to convert string values to.
* @see MaskFormatter
*/
- public MaskConverter(String mask, Class/*<?>*/ type)
+ public MaskConverter(String mask, Class/* <?> */type)
{
try
{
