[picocontainer-scm] [5627] java/2.x/trunk/pico/container/src/java/org/picocontainer: Cleanup of javadoc and generics warnings for converters.

Revision 5627
Author mauro
Date 2010-02-21 03:18:12 -0600 (Sun, 21 Feb 2010)

Log Message

Cleanup of javadoc and generics warnings for converters.

Modified Paths

- java/2.x/trunk/pico/container/src/java/org/picocontainer/Converters.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BooleanConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BuiltInConverters.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ByteConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/CharacterConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/Converter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ConvertsNothing.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/DoubleConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FileConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FloatConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/IntegerConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/LongConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/NewInstanceConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ShortConverter.java

- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/UrlConverter.java

Diff

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/Converters.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/Converters.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/Converters.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -11,23 +11,26 @@

/**
* A facade for a collection of converters that provides string-to-type conversions.
- * @author Paul Hammant, Michael Rimov
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
public interface Converters {

/**
- * Returns true if the set of converters can convert between strings and the target
- * type.
- * @param type
- * @return true if the target type can convert.
+ * Returns true if a converters is available to convert to the given object type
+ *
+ * @param type the object Type to convert to
+ * @return true if the type can be converted to
*/
boolean canConvert(Type type);

/**
- * Converts a particular string value into the target type.
- * @param paramValue
- * @param type
- * @return the target object.
+ * Converts a particular string value into the target type
+ *
+ * @param value the String value to convert
+ * @param type the object Type to convert to
+ * @return The converted Object instance
*/
- Object convert(String paramValue, Type type);
+ Object convert(String value, Type type);
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BooleanConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BooleanConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BooleanConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -4,13 +4,13 @@

/**
- * Converts strings to boolean types.
- * @author Paul Hammant, Michael Rimov
+ * Converts values to 'boolean' data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class BooleanConverter implements Converter<Boolean> {

-
- /** {@inheritDoc} **/
public Boolean convert(String paramValue) {
return Boolean.valueOf(paramValue);
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BuiltInConverters.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BuiltInConverters.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/BuiltInConverters.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -12,7 +12,7 @@
@SuppressWarnings("serial")
public class BuiltInConverters implements Converters, Serializable {

- private final Map<Class, Converter> converters = new HashMap<Class, Converter>();
+ private final Map<Class<?>, Converter<?>> converters = new HashMap<Class<?>, Converter<?>>();

public BuiltInConverters() {
addBuiltInConverters();
@@ -31,12 +31,12 @@
addConverter(new UrlConverter(), URL.class);
}

- private void addConverter(Converter converter, Class<?> type, Class<?> type2) {
+ private void addConverter(Converter<?> converter, Class<?> type, Class<?> type2) {
addConverter(converter, type);
addConverter(converter, type2);
}

- protected void addConverter(Converter converter, Class<?> key) {
+ protected void addConverter(Converter<?> converter, Class<?> key) {
converters.put(key, converter);
}

@@ -45,7 +45,7 @@
}

public Object convert(String paramValue, Type type) {
- Converter converter = converters.get(type);
+ Converter<?> converter = converters.get(type);
if (converter== null) {
return null;
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ByteConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ByteConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ByteConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -3,13 +3,15 @@
import org.picocontainer.converters.Converter;

/**
- * Converts
- *
+ * Converts values to 'byte' data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
-class ByteConverter implements Converter {
+class ByteConverter implements Converter<Byte> {

- /** {@inheritDoc} **/
- public Object convert(String paramValue) {
+ public Byte convert(String paramValue) {
return Byte.valueOf(paramValue);
}
+
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/CharacterConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/CharacterConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/CharacterConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -4,9 +4,11 @@

/**
- * Converts strings to characters. It does so by only grabbing
+ * Converts string to single-character. It does so by only grabbing
* the first character in the string.
- * @author Paul Hammant, Michael Rimov
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class CharacterConverter implements Converter<Character> {

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/Converter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/Converter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/Converter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -8,9 +8,10 @@
package org.picocontainer.converters;

/**
- * Interface for all type converters. This interface is actually hidden inside
- * the ConverterSet facade.
- * @author Paul Hammant, Michael Rimov
+ * Interface for type converters.
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
public interface Converter<T> {

@@ -20,4 +21,5 @@
* @return the resulting object.
*/
T convert(String parameterValue);
+
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ConvertsNothing.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ConvertsNothing.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ConvertsNothing.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -4,9 +4,11 @@

import java.lang.reflect.Type;

-@SuppressWarnings("unused")
+/**
+ * Null-object implementation of Converters
+ */
public class ConvertsNothing implements Converters {
- public boolean canConvert( Type type) {
+ public boolean canConvert(Type type) {
return false;
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/DoubleConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/DoubleConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/DoubleConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -4,14 +4,13 @@

/**
- * Converts strings to double-precision floating point values..
- * @author Paul Hammant, Michael Rimov
+ * Converts values to 'double' data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class DoubleConverter implements Converter<Double> {

- /**
- * {@inheritDoc}
- */
public Double convert(String paramValue) {
return Double.valueOf(paramValue);
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FileConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FileConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FileConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -5,12 +5,13 @@
import java.io.File;

/**
- * Converts strings to files.
- * @author Paul Hammant, Michael Rimov
+ * Converts values to File data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class FileConverter implements Converter<File> {

- /** {@inheritDoc} **/
public File convert(String paramValue) {
return new File(paramValue);
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FloatConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FloatConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/FloatConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -4,8 +4,10 @@

/**
- * Converts strings to boolean types.
- * @author Paul Hammant, Michael Rimov
+ * Converts values to 'float' data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class FloatConverter implements Converter<Float> {

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/IntegerConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/IntegerConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/IntegerConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -4,12 +4,13 @@

/**
- * Converts strings to integer types.
- * @author Paul Hammant, Michael Rimov
+ * Converts values to 'int' data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class IntegerConverter implements Converter<Integer> {

- /** {@inheritDoc} **/
public Integer convert(String paramValue) {
return Integer.valueOf(paramValue);
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/LongConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/LongConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/LongConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -4,12 +4,13 @@

/**
- * Converts strings to long-integer types.
- * @author Paul Hammant, Michael Rimov
+ * Converts values to 'long' data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class LongConverter implements Converter<Long> {

- /** {@inheritDoc} **/
public Long convert(String paramValue) {
return Long.valueOf(paramValue);
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/NewInstanceConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/NewInstanceConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/NewInstanceConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -5,16 +5,22 @@
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;

-public class NewInstanceConverter implements Converter {
- private Constructor c;
+/**
+ * Converts a value to an object via its single-String constructor.
+ */
+public class NewInstanceConverter implements Converter<Object> {
+ private Constructor<?> c;

- public NewInstanceConverter(Class clazz) {
+ public NewInstanceConverter(Class<?> clazz) {
try {
c = clazz.getConstructor(String.class);
} catch (NoSuchMethodException e) {
}
}
public Object convert(String paramValue) {
+ if ( c == null ){
+ return null;
+ }
try {
return c.newInstance(paramValue);
} catch (IllegalAccessException e) {

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ShortConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ShortConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/ShortConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -2,16 +2,14 @@

import org.picocontainer.converters.Converter;

-
/**
- * Converts strings to 'short' data type objects.
- * @author Paul Hammant, Michael Rimov
+ * Converts values to 'short' data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
*/
class ShortConverter implements Converter<Short> {

- /**
- * {@inheritDoc}
- */
public Short convert(String paramValue) {
return Short.valueOf(paramValue);
}

Modified: java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/UrlConverter.java (5626 => 5627)

--- java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/UrlConverter.java 2010-02-21 01:48:54 UTC (rev 5626)
+++ java/2.x/trunk/pico/container/src/java/org/picocontainer/converters/UrlConverter.java 2010-02-21 09:18:12 UTC (rev 5627)
@@ -5,11 +5,14 @@
import java.net.MalformedURLException;
import java.net.URL;

+/**
+ * Converts values to URL data type objects
+ *
+ * @author Paul Hammant
+ * @author Michael Rimov
+ */
public class UrlConverter implements Converter<URL> {

- /**
- * {@inheritDoc} *
- */
public URL convert(String paramValue) {
try {
return new URL(paramValue);

----------

To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email