You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by sv...@apache.org on 2012/07/31 20:40:53 UTC

git commit: improved javadoc

Updated Branches:
  refs/heads/master fe0815b58 -> c59ebe827


improved javadoc


Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/c59ebe82
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/c59ebe82
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/c59ebe82

Branch: refs/heads/master
Commit: c59ebe827d104f297c0a02a56bcdbe67bb37218a
Parents: fe0815b
Author: svenmeier <sv...@apache.org>
Authored: Tue Jul 31 20:30:27 2012 +0200
Committer: svenmeier <sv...@apache.org>
Committed: Tue Jul 31 20:30:27 2012 +0200

----------------------------------------------------------------------
 .../markup/html/repeater/tree/AbstractTree.java    |    5 +++++
 .../markup/html/repeater/util/ProviderSubset.java  |    9 ++++-----
 2 files changed, 9 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/c59ebe82/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/tree/AbstractTree.java
----------------------------------------------------------------------
diff --git a/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/tree/AbstractTree.java b/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/tree/AbstractTree.java
index d3b9457..4bc6b0e 100644
--- a/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/tree/AbstractTree.java
+++ b/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/tree/AbstractTree.java
@@ -123,6 +123,11 @@ public abstract class AbstractTree<T> extends Panel
 
 	/**
 	 * Factory method for a model, by default creates a model containing a {@link ProviderSubset}.
+	 * Depending on your {@link ITreeProvider}'s model you might consider to provide a custom
+	 * {@link Set} implementation.
+	 * <p>
+	 * Note: The contained {@link Set} has at least to implement {@link Set#add(Object)},
+	 * {@link Set#remove(Object)} and {@link Set#contains(Object)}.
 	 * 
 	 * @return model for this tree
 	 */

http://git-wip-us.apache.org/repos/asf/wicket/blob/c59ebe82/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/util/ProviderSubset.java
----------------------------------------------------------------------
diff --git a/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/util/ProviderSubset.java b/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/util/ProviderSubset.java
index 2b7dd5c..f5ec011 100644
--- a/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/util/ProviderSubset.java
+++ b/wicket-extensions/src/main/java/org/apache/wicket/extensions/markup/html/repeater/util/ProviderSubset.java
@@ -27,15 +27,14 @@ import org.apache.wicket.model.IDetachable;
 import org.apache.wicket.model.IModel;
 
 /**
- * A subset of a {@link ITreeProvider}'s tree offering automatic detachment.
- * 
- * Make sure that the containing model calls {@link IDetachable#detach()} on its model object.
- * 
- * @see ITreeProvider#model(Object)
+ * A {@link Set} implementation utilizing a {@link ITreeProvider}'s models to keep containing
+ * elements.
  * 
  * @author svenmeier
  * @param <T>
  *            type of data
+ * 
+ * @see ITreeProvider#model(Object)
  */
 public class ProviderSubset<T> implements Set<T>, IDetachable
 {