From: Artur Signell <artur@vaadin.com>
Date: Thu, 22 Dec 2011 07:18:16 +0000 (+0200)
Subject: Javadoc fixes
X-Git-Tag: 7.0.0.alpha1~34
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=5c357fb2d462515e02e42c1655b9b16b93c21505;p=vaadin-framework.git

Javadoc fixes
---

diff --git a/src/com/vaadin/data/util/converter/Converter.java b/src/com/vaadin/data/util/converter/Converter.java
index f48246ff4c..065d06b071 100644
--- 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;
 
 /**
- * Interface that implements conversion between objects between model and
- * presentation types.
+ * Interface that implements conversion between a model and a presentation type.
  * <p>
  * Typically {@link #convertToPresentation(Object, Locale)} and
  * {@link #convertToModel(Object, Locale)} should be symmetric so that chaining
diff --git a/src/com/vaadin/data/util/converter/DateToLongConverter.java b/src/com/vaadin/data/util/converter/DateToLongConverter.java
index c9a76ec39b..d66adece06 100644
--- 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)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,
+     * java.util.Locale)
      */
     public Long convertToModel(Date value, Locale locale) {
         if (value == null) {
@@ -36,8 +36,8 @@ public class DateToLongConverter implements Converter<Date, Long> {
      * (non-Javadoc)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
+     * .Object, java.util.Locale)
      */
     public Date convertToPresentation(Long value, Locale locale) {
         if (value == null) {
@@ -50,7 +50,7 @@ public class DateToLongConverter implements Converter<Date, Long> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()
+     * @see com.vaadin.data.util.converter.Converter#getModelType()
      */
     public Class<Long> getModelType() {
         return Long.class;
@@ -59,7 +59,7 @@ public class DateToLongConverter implements Converter<Date, Long> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()
      */
     public Class<Date> getPresentationType() {
         return Date.class;
diff --git a/src/com/vaadin/data/util/converter/ReverseConverter.java b/src/com/vaadin/data/util/converter/ReverseConverter.java
index 45f5abda65..b191d1ca0b 100644
--- 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
     /*
      * (non-Javadoc)
      * 
-     * @see
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java
+     * @see com.vaadin.data.util.converter.Converter#convertToModel(java
      * .lang.Object, java.util.Locale)
      */
     public MODEL convertToModel(PRESENTATION value, Locale locale)
@@ -52,8 +51,8 @@ public class ReverseConverter<PRESENTATION, MODEL> implements
      * (non-Javadoc)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
+     * .Object, java.util.Locale)
      */
     public PRESENTATION convertToPresentation(MODEL value, Locale locale)
             throws com.vaadin.data.util.converter.Converter.ConversionException {
diff --git a/src/com/vaadin/data/util/converter/StringToBooleanConverter.java b/src/com/vaadin/data/util/converter/StringToBooleanConverter.java
index 5dfcf87e40..1913266db2 100644
--- 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)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,
+     * java.util.Locale)
      */
     public Boolean convertToModel(String value, Locale locale)
             throws ConversionException {
@@ -46,10 +46,20 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
         }
     }
 
+    /**
+     * Gets the string representation for true. Default is "true".
+     * 
+     * @return the string representation for true
+     */
     protected String getTrueString() {
         return Boolean.TRUE.toString();
     }
 
+    /**
+     * Gets the string representation for false. Default is "false".
+     * 
+     * @return the string representation for false
+     */
     protected String getFalseString() {
         return Boolean.FALSE.toString();
     }
@@ -58,8 +68,8 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
      * (non-Javadoc)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
+     * .Object, java.util.Locale)
      */
     public String convertToPresentation(Boolean value, Locale locale)
             throws ConversionException {
@@ -76,7 +86,7 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()
+     * @see com.vaadin.data.util.converter.Converter#getModelType()
      */
     public Class<Boolean> getModelType() {
         return Boolean.class;
@@ -85,7 +95,7 @@ public class StringToBooleanConverter implements Converter<String, Boolean> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()
      */
     public Class<String> getPresentationType() {
         return String.class;
diff --git a/src/com/vaadin/data/util/converter/StringToDateConverter.java b/src/com/vaadin/data/util/converter/StringToDateConverter.java
index c97090334d..96b144f6ea 100644
--- 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)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,
+     * java.util.Locale)
      */
     public Date convertToModel(String value, Locale locale)
             throws com.vaadin.data.util.converter.Converter.ConversionException {
@@ -75,8 +75,8 @@ public class StringToDateConverter implements Converter<String, Date> {
      * (non-Javadoc)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
+     * .Object, java.util.Locale)
      */
     public String convertToPresentation(Date value, Locale locale)
             throws com.vaadin.data.util.converter.Converter.ConversionException {
@@ -90,7 +90,7 @@ public class StringToDateConverter implements Converter<String, Date> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()
+     * @see com.vaadin.data.util.converter.Converter#getModelType()
      */
     public Class<Date> getModelType() {
         return Date.class;
@@ -99,7 +99,7 @@ public class StringToDateConverter implements Converter<String, Date> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()
      */
     public Class<String> getPresentationType() {
         return String.class;
diff --git a/src/com/vaadin/data/util/converter/StringToDoubleConverter.java b/src/com/vaadin/data/util/converter/StringToDoubleConverter.java
index 0c60aea5cb..d9441422ad 100644
--- 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)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,
+     * java.util.Locale)
      */
     public Double convertToModel(String value, Locale locale)
             throws ConversionException {
@@ -71,8 +71,8 @@ public class StringToDoubleConverter implements Converter<String, Double> {
      * (non-Javadoc)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
+     * .Object, java.util.Locale)
      */
     public String convertToPresentation(Double value, Locale locale)
             throws ConversionException {
@@ -86,7 +86,7 @@ public class StringToDoubleConverter implements Converter<String, Double> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()
+     * @see com.vaadin.data.util.converter.Converter#getModelType()
      */
     public Class<Double> getModelType() {
         return Double.class;
@@ -95,7 +95,7 @@ public class StringToDoubleConverter implements Converter<String, Double> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()
      */
     public Class<String> getPresentationType() {
         return String.class;
diff --git a/src/com/vaadin/data/util/converter/StringToNumberConverter.java b/src/com/vaadin/data/util/converter/StringToNumberConverter.java
index 8975dad9f3..c71b7180e9 100644
--- 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)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromTargetToSource(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToModel(java.lang.Object,
+     * java.util.Locale)
      */
     public Number convertToModel(String value, Locale locale)
             throws ConversionException {
@@ -74,8 +74,8 @@ public class StringToNumberConverter implements Converter<String, Number> {
      * (non-Javadoc)
      * 
      * @see
-     * com.vaadin.data.util.converter.Converter#convertFromSourceToTarget(java
-     * .lang.Object, java.util.Locale)
+     * com.vaadin.data.util.converter.Converter#convertToPresentation(java.lang
+     * .Object, java.util.Locale)
      */
     public String convertToPresentation(Number value, Locale locale)
             throws ConversionException {
@@ -89,7 +89,7 @@ public class StringToNumberConverter implements Converter<String, Number> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getSourceType()
+     * @see com.vaadin.data.util.converter.Converter#getModelType()
      */
     public Class<Number> getModelType() {
         return Number.class;
@@ -98,7 +98,7 @@ public class StringToNumberConverter implements Converter<String, Number> {
     /*
      * (non-Javadoc)
      * 
-     * @see com.vaadin.data.util.converter.Converter#getTargetType()
+     * @see com.vaadin.data.util.converter.Converter#getPresentationType()
      */
     public Class<String> getPresentationType() {
         return String.class;