From: Henri Sara <hesara@vaadin.com>
Date: Tue, 20 Dec 2011 08:12:07 +0000 (+0200)
Subject: Add javadoc for AbstractField.getInternalValue().
X-Git-Tag: 7.0.0.alpha1~85
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=1981c9153a04c2e93cd3d64e22cbf5e2f6bd1d26;p=vaadin-framework.git

Add javadoc for AbstractField.getInternalValue().
---

diff --git a/src/com/vaadin/ui/AbstractField.java b/src/com/vaadin/ui/AbstractField.java
index 339741545d..daef4c0ddb 100644
--- a/src/com/vaadin/ui/AbstractField.java
+++ b/src/com/vaadin/ui/AbstractField.java
@@ -1333,8 +1333,17 @@ public abstract class AbstractField<T> extends AbstractComponent implements
     }
 
     /**
+     * Returns the internal field value, which might not match the data source
+     * value e.g. if the field has been modified and is not in write-through
+     * mode.
+     * 
+     * This method can be overridden by subclasses together with
+     * {@link #setInternalValue(Object)} to compute internal field value at
+     * runtime. When doing so, typically also {@link #isModified()} needs to be
+     * overridden and care should be taken in the management of the empty state
+     * and buffering support.
      * 
-     * @return
+     * @return internal field value
      */
     protected T getInternalValue() {
         return value;
@@ -1346,6 +1355,8 @@ public abstract class AbstractField<T> extends AbstractComponent implements
      * It can be overridden by the inheriting classes to update all dependent
      * variables.
      * 
+     * Subclasses can also override {@link #getInternalValue()} if necessary.
+     * 
      * @param newValue
      *            the new value to be set.
      */