diff options
author | Aleksi Hietanen <aleksi@vaadin.com> | 2017-05-10 13:02:59 +0300 |
---|---|---|
committer | Henri Sara <henri.sara@gmail.com> | 2017-05-16 15:35:17 +0300 |
commit | d67f329f16ca1bf85e8af6a0276203b58bd26ed9 (patch) | |
tree | 7a01e5dd1a889b3666fcee2d32d5f7a79e9f4d9d | |
parent | 60207377759e349c3010235b43e4e2593ce72930 (diff) | |
download | vaadin-framework-d67f329f16ca1bf85e8af6a0276203b58bd26ed9.tar.gz vaadin-framework-d67f329f16ca1bf85e8af6a0276203b58bd26ed9.zip |
Clarify HierarchicalQuery javadocs
-rw-r--r-- | server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java b/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java index 92cf15ade9..cf6515b710 100644 --- a/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java +++ b/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java @@ -41,7 +41,8 @@ public class HierarchicalQuery<T, F> extends Query<T, F> { * @param filter * filtering for fetching; can be <code>null</code> * @param parent - * the hierarchical parent object, can be <code>null</code> + * the hierarchical parent object, <code>null</code> + * corresponding to the root node */ public HierarchicalQuery(F filter, T parent) { super(filter); @@ -63,7 +64,8 @@ public class HierarchicalQuery<T, F> extends Query<T, F> { * @param filter * filtering for fetching; can be <code>null</code> * @param parent - * the hierarchical parent object, can be <code>null</code> + * the hierarchical parent object, <code>null</code> + * corresponding to the root node */ public HierarchicalQuery(int offset, int limit, List<QuerySortOrder> sortOrders, Comparator<T> inMemorySorting, @@ -73,9 +75,10 @@ public class HierarchicalQuery<T, F> extends Query<T, F> { } /** - * Get the hierarchical parent object, can be <code>null</code>. + * Get the hierarchical parent object, where <code>null</code> corresponds + * to the root node. * - * @return the hierarchical parent object, can be <code>null</code> + * @return the hierarchical parent object */ public T getParent() { return parent; |