From 7ed6f85d6d73d524322ad8bc5de32d148bd9236f Mon Sep 17 00:00:00 2001
From: Henri Sara <henri.sara@itmill.com>
Date: Thu, 2 Dec 2010 11:53:17 +0000
Subject: #6074 some more javadoc

svn changeset:16276/svn branch:6.5
---
 src/com/vaadin/data/util/BeanContainer.java | 28 +++++++++++++++++++++-------
 1 file changed, 21 insertions(+), 7 deletions(-)

(limited to 'src/com/vaadin/data/util/BeanContainer.java')

diff --git a/src/com/vaadin/data/util/BeanContainer.java b/src/com/vaadin/data/util/BeanContainer.java
index 3fe7ae20ca..a4a7fcbf6f 100644
--- a/src/com/vaadin/data/util/BeanContainer.java
+++ b/src/com/vaadin/data/util/BeanContainer.java
@@ -15,21 +15,35 @@ import com.vaadin.data.Item;
  * 
  * <p>
  * In BeanContainer (unlike {@link BeanItemContainer}), the item IDs do not have
- * to be the beans themselves.
+ * to be the beans themselves. The container can be used either with explicit
+ * item IDs or the item IDs can be generated when adding beans.
  * </p>
  * 
  * <p>
- * It is not possible to add additional properties to the container and nested
- * bean properties are not supported.
+ * To use explicit item IDs, use the methods {@link #addItem(Object, Object)},
+ * {@link #addItemAfter(Object, Object, Object)} and
+ * {@link #addItemAt(int, Object, Object)}.
  * </p>
  * 
  * <p>
- * If a bean id resolver is set, the {@link #addBean(Object)},
+ * If a bean id resolver is set using
+ * {@link #setBeanIdResolver(com.vaadin.data.util.AbstractBeanContainer.BeanIdResolver)}
+ * or {@link #setBeanIdProperty(Object)}, the methods {@link #addBean(Object)},
  * {@link #addBeanAfter(Object, Object)}, {@link #addBeanAt(int, Object)} and
- * {@link #addAll(java.util.Collection)} methods can be used to add items to the
+ * {@link #addAll(java.util.Collection)} can be used to add items to the
  * container. If one of these methods is called, the resolver is used to
- * generate an identifier for the item (must not return null). Explicit item
- * identifiers can be used also when a resolver has been set.
+ * generate an identifier for the item (must not return null).
+ * </p>
+ * 
+ * <p>
+ * Note that explicit item identifiers can also be used when a resolver has been
+ * set by calling the addItem*() methods - the resolver is only used when adding
+ * beans using the addBean*() methods.
+ * </p>
+ * 
+ * <p>
+ * It is not possible to add additional properties to the container and nested
+ * bean properties are not supported.
  * </p>
  * 
  * @param <IDTYPE>
-- 
cgit v1.2.3