From 6176acd274830fb343bd11739e6036b4f04e2dc0 Mon Sep 17 00:00:00 2001
From: Henri Sara <henri.sara@itmill.com>
Date: Tue, 8 Mar 2011 08:31:35 +0000
Subject: [PATCH] #6527 Container refactoring: default implementations (throw
 new UnsupportedOperationException()) for adding/removing items or container
 properties in AbstractInMemoryContainer, subclasses need to override to
 support these operations

svn changeset:17656/svn branch:6.6
---
 .../data/util/AbstractBeanContainer.java      | 48 ++-----------
 .../data/util/AbstractInMemoryContainer.java  | 72 +++++++++++++++++++
 src/com/vaadin/data/util/BeanContainer.java   | 16 -----
 .../vaadin/data/util/BeanItemContainer.java   | 29 +++-----
 4 files changed, 86 insertions(+), 79 deletions(-)

diff --git a/src/com/vaadin/data/util/AbstractBeanContainer.java b/src/com/vaadin/data/util/AbstractBeanContainer.java
index 197e844dde..31ad37a57f 100644
--- a/src/com/vaadin/data/util/AbstractBeanContainer.java
+++ b/src/com/vaadin/data/util/AbstractBeanContainer.java
@@ -26,8 +26,8 @@ import com.vaadin.data.Property.ValueChangeNotifier;
  * 
  * <p>
  * The properties of the container are determined automatically by introspecting
- * the used JavaBean class. Only beans of the same type can be added to the
- * container.
+ * the used JavaBean class and explicitly adding or removing properties is not
+ * supported. Only beans of the same type can be added to the container.
  * </p>
  * 
  * <p>
@@ -216,29 +216,12 @@ public abstract class AbstractBeanContainer<IDTYPE, BEANTYPE> extends
         return model.keySet();
     }
 
-    /**
-     * Unsupported operation. Properties are determined by the introspecting the
-     * bean class.
-     */
-    public boolean addContainerProperty(Object propertyId, Class<?> type,
-            Object defaultValue) throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
-    /**
-     * Unsupported operation. Properties are determined by the introspecting the
-     * bean class.
-     */
-    public boolean removeContainerProperty(Object propertyId)
-            throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
     /*
      * (non-Javadoc)
      * 
      * @see com.vaadin.data.Container#removeAllItems()
      */
+    @Override
     public boolean removeAllItems() {
         int origSize = size();
 
@@ -303,6 +286,7 @@ public abstract class AbstractBeanContainer<IDTYPE, BEANTYPE> extends
      * 
      * @see com.vaadin.data.Container#removeItem(java.lang.Object)
      */
+    @Override
     public boolean removeItem(Object itemId) {
         int origSize = size();
         Item item = getItem(itemId);
@@ -425,22 +409,6 @@ public abstract class AbstractBeanContainer<IDTYPE, BEANTYPE> extends
         }
     }
 
-    /**
-     * Unsupported operation. Use other methods to add items.
-     */
-    public Object addItemAfter(Object previousItemId)
-            throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
-    /**
-     * Unsupported operation. Beans should be added through
-     * {@code addItemAt(int, ...)}.
-     */
-    public Object addItemAt(int index) throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
     /*
      * (non-Javadoc)
      * 
@@ -471,14 +439,6 @@ public abstract class AbstractBeanContainer<IDTYPE, BEANTYPE> extends
         super.setItemSorter(itemSorter);
     }
 
-    /**
-     * Unsupported operation. See subclasses of {@link AbstractBeanContainer}
-     * for the correct way to add items.
-     */
-    public Object addItem() throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
     @Override
     protected void registerNewItem(int position, IDTYPE itemId,
             BeanItem<BEANTYPE> item) {
diff --git a/src/com/vaadin/data/util/AbstractInMemoryContainer.java b/src/com/vaadin/data/util/AbstractInMemoryContainer.java
index ae768cd497..58e2b5131a 100644
--- a/src/com/vaadin/data/util/AbstractInMemoryContainer.java
+++ b/src/com/vaadin/data/util/AbstractInMemoryContainer.java
@@ -19,6 +19,20 @@ import com.vaadin.data.Item;
  * this class, inherit {@link AbstractContainer}, or implement the
  * {@link Container} interface directly.
  * 
+ * Adding and removing items (if desired) must be implemented in subclasses by
+ * overriding the appropriate add*Item() and remove*Item() and removeAllItems()
+ * methods, calling the corresponding
+ * {@link #internalAddItemAfter(Object, Object, Item)},
+ * {@link #internalAddItemAt(int, Object, Item)},
+ * {@link #internalAddItemAtEnd(Object, Item, boolean)},
+ * {@link #internalRemoveItem(Object)} and {@link #internalRemoveAllItems()}
+ * methods.
+ * 
+ * By default, adding and removing container properties is not supported, and
+ * subclasses need to implement {@link #getContainerPropertyIds()}. Optionally,
+ * subclasses can override {@link #addContainerProperty(Object, Class, Object)}
+ * and {@link #removeContainerProperty(Object)} to implement them.
+ * 
  * Features:
  * <ul>
  * <li> {@link Container.Ordered}
@@ -225,6 +239,64 @@ public abstract class AbstractInMemoryContainer<ITEMIDTYPE, PROPERTYIDCLASS, ITE
         return getVisibleItemIds().indexOf(itemId);
     }
 
+    // methods that are unsupported by default, override to support
+
+    public Object addItemAt(int index) throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Adding items not supported. Override the relevant addItem*() methods if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public Item addItemAt(int index, Object newItemId)
+            throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Adding items not supported. Override the relevant addItem*() methods if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public Object addItemAfter(Object previousItemId)
+            throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Adding items not supported. Override the relevant addItem*() methods if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public Item addItemAfter(Object previousItemId, Object newItemId)
+            throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Adding items not supported. Override the relevant addItem*() methods if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public Item addItem(Object itemId) throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Adding items not supported. Override the relevant addItem*() methods if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public Object addItem() throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Adding items not supported. Override the relevant addItem*() methods if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public boolean removeItem(Object itemId)
+            throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Removing items not supported. Override the removeItem() method if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public boolean removeAllItems() throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Removing items not supported. Override the removeAllItems() method if required as specified in AbstractInMemoryContainer javadoc.");
+    }
+
+    public boolean addContainerProperty(Object propertyId, Class<?> type,
+            Object defaultValue) throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Adding container properties not supported. Override the addContainerProperty() method if required.");
+    }
+
+    public boolean removeContainerProperty(Object propertyId)
+            throws UnsupportedOperationException {
+        throw new UnsupportedOperationException(
+                "Removing container properties not supported. Override the addContainerProperty() method if required.");
+    }
+
     // ItemSetChangeNotifier
 
     @Override
diff --git a/src/com/vaadin/data/util/BeanContainer.java b/src/com/vaadin/data/util/BeanContainer.java
index 46e29dc286..f74b2bfb24 100644
--- a/src/com/vaadin/data/util/BeanContainer.java
+++ b/src/com/vaadin/data/util/BeanContainer.java
@@ -2,8 +2,6 @@ package com.vaadin.data.util;
 
 import java.util.Collection;
 
-import com.vaadin.data.Item;
-
 /**
  * An in-memory container for JavaBeans.
  * 
@@ -63,20 +61,6 @@ public class BeanContainer<IDTYPE, BEANTYPE> extends
         super(type);
     }
 
-    public Item addItemAt(int index, Object newItemId)
-            throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
-    public Item addItemAfter(Object previousItemId, Object newItemId)
-            throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
-    public Item addItem(Object itemId) throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
     /**
      * Adds the bean to the Container.
      * 
diff --git a/src/com/vaadin/data/util/BeanItemContainer.java b/src/com/vaadin/data/util/BeanItemContainer.java
index a9c8a0a62c..a1f8872da4 100644
--- a/src/com/vaadin/data/util/BeanItemContainer.java
+++ b/src/com/vaadin/data/util/BeanItemContainer.java
@@ -24,6 +24,13 @@ import java.util.Collection;
  * </p>
  * 
  * <p>
+ * To add items to the container, use the methods {@link #addBean(Object)},
+ * {@link #addBeanAfter(Object, Object)} and {@link #addBeanAt(int, Object)}.
+ * Also {@link #addItem(Object)}, {@link #addItemAfter(Object, Object)} and
+ * {@link #addItemAt(int, Object)} can be used as synonyms for them.
+ * </p>
+ * 
+ * <p>
  * It is not possible to add additional properties to the container and nested
  * bean properties are not supported.
  * </p>
@@ -144,25 +151,6 @@ public class BeanItemContainer<BEANTYPE> extends
         }
     }
 
-    /**
-     * Unsupported operation. Use {@link #addBean(Object)} instead.
-     */
-    // overridden for javadoc only
-    @Override
-    public Object addItem() throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
-    /**
-     * Unsupported operation. Use {@link #addItemAfter(Object, Object)}.
-     */
-    // overridden for javadoc only
-    @Override
-    public Object addItemAfter(Object previousItemId)
-            throws UnsupportedOperationException {
-        throw new UnsupportedOperationException();
-    }
-
     /**
      * Adds all the beans from a {@link Collection} in one go. More efficient
      * than adding them one by one.
@@ -187,6 +175,7 @@ public class BeanItemContainer<BEANTYPE> extends
      * 
      * @see com.vaadin.data.Container.Ordered#addItemAfter(Object, Object)
      */
+    @Override
     @SuppressWarnings("unchecked")
     public BeanItem<BEANTYPE> addItemAfter(Object previousItemId,
             Object newItemId) throws IllegalArgumentException {
@@ -205,6 +194,7 @@ public class BeanItemContainer<BEANTYPE> extends
      *            The bean to add to the container.
      * @return Returns the new BeanItem or null if the operation fails.
      */
+    @Override
     @SuppressWarnings("unchecked")
     public BeanItem<BEANTYPE> addItemAt(int index, Object newItemId)
             throws IllegalArgumentException {
@@ -218,6 +208,7 @@ public class BeanItemContainer<BEANTYPE> extends
      * 
      * @see com.vaadin.data.Container#addItem(Object)
      */
+    @Override
     @SuppressWarnings("unchecked")
     public BeanItem<BEANTYPE> addItem(Object itemId) {
         return super.addBean((BEANTYPE) itemId);
-- 
2.39.5