From 1ae161965d5b9b9bc6aae041ab80c906460ede83 Mon Sep 17 00:00:00 2001
From: Artur Signell <artur@vaadin.com>
Date: Tue, 16 Dec 2014 10:05:54 +0200
Subject: Clarified javadoc (#7749)

Change-Id: I89d55fdc9b380f90940477e1d4d031394c81ee40
---
 server/src/com/vaadin/ui/Component.java | 21 +++++++++++++--------
 1 file changed, 13 insertions(+), 8 deletions(-)

(limited to 'server/src')

diff --git a/server/src/com/vaadin/ui/Component.java b/server/src/com/vaadin/ui/Component.java
index 78fb643ba9..9e0816a398 100644
--- a/server/src/com/vaadin/ui/Component.java
+++ b/server/src/com/vaadin/ui/Component.java
@@ -732,9 +732,15 @@ public interface Component extends ClientConnector, Sizeable, Serializable {
     /* Declarative support */
 
     /**
-     * Update the component state based on the given design. The component is
-     * responsible not only for updating itself but also ensuring that its
-     * children update their state based on the design.
+     * Reads the component state from the given design.
+     * <p>
+     * The component is responsible not only for updating its own state but also
+     * for ensuring that its children update their state based on the design.
+     * <p>
+     * It is assumed that the component is in its default state when this method
+     * is called. Reading should only take into consideration attributes
+     * specified in the design and not reset any unspecified attributes to their
+     * defaults.
      * <p>
      * This method must not modify the design.
      * 
@@ -747,11 +753,10 @@ public interface Component extends ClientConnector, Sizeable, Serializable {
     public void readDesign(Element design, DesignContext designContext);
 
     /**
-     * Update the given design based on the component state. The component is
-     * responsible not only for updating itself but also for ensuring its
-     * children update themselves in the correct position in the design. The
-     * caller of this method should not assume that contents of the
-     * <code>design</code> parameter are presented.
+     * Writes the component state to the given design.
+     * <p>
+     * The component is responsible not only for writing its own state but also
+     * for ensuring that its children write their state to the design.
      * <p>
      * This method must not modify the component state.
      * 
-- 
cgit v1.2.3