Javadoc fixes

diff --git a/src/com/vaadin/data/util/converter/Converter.java b/src/com/vaadin/data/util/converter/Converter.java
index f48246ff4cd30c2e74f92a461b35a5ff7050fe8c..065d06b07150d2920dd120b711ddc8afbffb8331 100644 (file)
--- a/src/com/vaadin/data/util/converter/Converter.java
+++ b/src/com/vaadin/data/util/converter/Converter.java
@@ -8,8 +8,7 @@ import java.io.Serializable;
 import java.util.Locale;\r
 \r
 /**\r
- * Interface that implements conversion between objects between model and\r
- * presentation types.\r
+ * Interface that implements conversion between a model and a presentation type.\r
  * <p>\r
  * Typically {@link #convertToPresentation(Object, Locale)} and\r
  * {@link #convertToModel(Object, Locale)} should be symmetric so that chaining\r

diff --git a/src/com/vaadin/data/util/converter/DateToLongConverter.java b/src/com/vaadin/data/util/converter/DateToLongConverter.java
index c9a76ec39b8d859024933a317f6d080b158039ea..d66adece06dfbaa9e22b6c312b90d9e1d6db766a 100644 (file)
--- a/src/com/vaadin/data/util/converter/DateToLongConverter.java
+++ b/src/com/vaadin/data/util/converter/DateToLongConverter.java
@@ -21,8 +21,8 @@ public class DateToLongConverter implements Converter<Date, Long> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,\r
+     * java.util.Locale)\r
      */\r
     public Long convertToModel(Date value, Locale locale) {\r
         if (value == null) {\r
@@ -36,8 +36,8 @@ public class DateToLongConverter implements Converter<Date, Long> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang\r
+     * .Object, java.util.Locale)\r
      */\r
     public Date convertToPresentation(Long value, Locale locale) {\r
         if (value == null) {\r
@@ -50,7 +50,7 @@ public class DateToLongConverter implements Converter<Date, Long> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()\r
+     * @see com.vaadin.data.util.converter.Converter#getModelType()\r
      */\r
     public Class<Long> getModelType() {\r
         return Long.class;\r
@@ -59,7 +59,7 @@ public class DateToLongConverter implements Converter<Date, Long> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()\r
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()\r
      */\r
     public Class<Date> getPresentationType() {\r
         return Date.class;\r

diff --git a/src/com/vaadin/data/util/converter/ReverseConverter.java b/src/com/vaadin/data/util/converter/ReverseConverter.java
index 45f5abda6527cde7d7fc8a7a6b3d422828864bcb..b191d1ca0bce63801e67e55b79d06c64f1f03bf1 100644 (file)
--- a/src/com/vaadin/data/util/converter/ReverseConverter.java
+++ b/src/com/vaadin/data/util/converter/ReverseConverter.java
@@ -39,8 +39,7 @@ public class ReverseConverter<PRESENTATION, MODEL> implements
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java\r
+     * @see com.vaadin.data.util.converter.Converter#convertToModel(java\r
      * .lang.Object, java.util.Locale)\r
      */\r
     public MODEL convertToModel(PRESENTATION value, Locale locale)\r
@@ -52,8 +51,8 @@ public class ReverseConverter<PRESENTATION, MODEL> implements
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang\r
+     * .Object, java.util.Locale)\r
      */\r
     public PRESENTATION convertToPresentation(MODEL value, Locale locale)\r
             throws com.vaadin.data.util.converter.Converter.ConversionException {\r

diff --git a/src/com/vaadin/data/util/converter/StringToBooleanConverter.java b/src/com/vaadin/data/util/converter/StringToBooleanConverter.java
index 5dfcf87e40b0f2805e47ea7cd5349fe20f46ee0d..1913266db2d2494aaff0b31c9a17f4a02cd77fd8 100644 (file)
--- a/src/com/vaadin/data/util/converter/StringToBooleanConverter.java
+++ b/src/com/vaadin/data/util/converter/StringToBooleanConverter.java
@@ -24,8 +24,8 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,\r
+     * java.util.Locale)\r
      */\r
     public Boolean convertToModel(String value, Locale locale)\r
             throws ConversionException {\r
@@ -46,10 +46,20 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
         }\r
     }\r
 \r
+    /**\r
+     * Gets the string representation for true. Default is "true".\r
+     * \r
+     * @return the string representation for true\r
+     */\r
     protected String getTrueString() {\r
         return Boolean.TRUE.toString();\r
     }\r
 \r
+    /**\r
+     * Gets the string representation for false. Default is "false".\r
+     * \r
+     * @return the string representation for false\r
+     */\r
     protected String getFalseString() {\r
         return Boolean.FALSE.toString();\r
     }\r
@@ -58,8 +68,8 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang\r
+     * .Object, java.util.Locale)\r
      */\r
     public String convertToPresentation(Boolean value, Locale locale)\r
             throws ConversionException {\r
@@ -76,7 +86,7 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()\r
+     * @see com.vaadin.data.util.converter.Converter#getModelType()\r
      */\r
     public Class<Boolean> getModelType() {\r
         return Boolean.class;\r
@@ -85,7 +95,7 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()\r
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()\r
      */\r
     public Class<String> getPresentationType() {\r
         return String.class;\r

diff --git a/src/com/vaadin/data/util/converter/StringToDateConverter.java b/src/com/vaadin/data/util/converter/StringToDateConverter.java
index c97090334d219a18751bfb5a6e5b768b5e9a157a..96b144f6ea971c29c8a3e255b9c0b9e7fd33b38b 100644 (file)
--- a/src/com/vaadin/data/util/converter/StringToDateConverter.java
+++ b/src/com/vaadin/data/util/converter/StringToDateConverter.java
@@ -49,8 +49,8 @@ public class StringToDateConverter implements Converter<String, Date> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,\r
+     * java.util.Locale)\r
      */\r
     public Date convertToModel(String value, Locale locale)\r
             throws com.vaadin.data.util.converter.Converter.ConversionException {\r
@@ -75,8 +75,8 @@ public class StringToDateConverter implements Converter<String, Date> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang\r
+     * .Object, java.util.Locale)\r
      */\r
     public String convertToPresentation(Date value, Locale locale)\r
             throws com.vaadin.data.util.converter.Converter.ConversionException {\r
@@ -90,7 +90,7 @@ public class StringToDateConverter implements Converter<String, Date> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()\r
+     * @see com.vaadin.data.util.converter.Converter#getModelType()\r
      */\r
     public Class<Date> getModelType() {\r
         return Date.class;\r
@@ -99,7 +99,7 @@ public class StringToDateConverter implements Converter<String, Date> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()\r
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()\r
      */\r
     public Class<String> getPresentationType() {\r
         return String.class;\r

diff --git a/src/com/vaadin/data/util/converter/StringToDoubleConverter.java b/src/com/vaadin/data/util/converter/StringToDoubleConverter.java
index 0c60aea5cb9714d44d1454936fcfb7b09cc4e8f8..d9441422adb483b55d2b875da3d06db566846ec5 100644 (file)
--- a/src/com/vaadin/data/util/converter/StringToDoubleConverter.java
+++ b/src/com/vaadin/data/util/converter/StringToDoubleConverter.java
@@ -46,8 +46,8 @@ public class StringToDoubleConverter implements Converter<String, Double> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,\r
+     * java.util.Locale)\r
      */\r
     public Double convertToModel(String value, Locale locale)\r
             throws ConversionException {\r
@@ -71,8 +71,8 @@ public class StringToDoubleConverter implements Converter<String, Double> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang\r
+     * .Object, java.util.Locale)\r
      */\r
     public String convertToPresentation(Double value, Locale locale)\r
             throws ConversionException {\r
@@ -86,7 +86,7 @@ public class StringToDoubleConverter implements Converter<String, Double> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()\r
+     * @see com.vaadin.data.util.converter.Converter#getModelType()\r
      */\r
     public Class<Double> getModelType() {\r
         return Double.class;\r
@@ -95,7 +95,7 @@ public class StringToDoubleConverter implements Converter<String, Double> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()\r
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()\r
      */\r
     public Class<String> getPresentationType() {\r
         return String.class;\r

diff --git a/src/com/vaadin/data/util/converter/StringToNumberConverter.java b/src/com/vaadin/data/util/converter/StringToNumberConverter.java
index 8975dad9f3c65e12ab0490da106cafdc30da1621..c71b7180e99528a070931be32055331833ce7b01 100644 (file)
--- a/src/com/vaadin/data/util/converter/StringToNumberConverter.java
+++ b/src/com/vaadin/data/util/converter/StringToNumberConverter.java
@@ -42,8 +42,8 @@ public class StringToNumberConverter implements Converter<String, Number> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,\r
+     * java.util.Locale)\r
      */\r
     public Number convertToModel(String value, Locale locale)\r
             throws ConversionException {\r
@@ -74,8 +74,8 @@ public class StringToNumberConverter implements Converter<String, Number> {
      * (non-Javadoc)\r
      * \r
      * @see\r
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java\r
-     * .lang.Object, java.util.Locale)\r
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang\r
+     * .Object, java.util.Locale)\r
      */\r
     public String convertToPresentation(Number value, Locale locale)\r
             throws ConversionException {\r
@@ -89,7 +89,7 @@ public class StringToNumberConverter implements Converter<String, Number> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()\r
+     * @see com.vaadin.data.util.converter.Converter#getModelType()\r
      */\r
     public Class<Number> getModelType() {\r
         return Number.class;\r
@@ -98,7 +98,7 @@ public class StringToNumberConverter implements Converter<String, Number> {
     /*\r
      * (non-Javadoc)\r
      * \r
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()\r
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()\r
      */\r
     public Class<String> getPresentationType() {\r
         return String.class;\r