From: Aleksi Hietanen <aleksi@vaadin.com>
Date: Wed, 10 May 2017 10:02:59 +0000 (+0300)
Subject: Clarify HierarchicalQuery javadocs
X-Git-Tag: 8.1.0.alpha8~21
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=d67f329f16ca1bf85e8af6a0276203b58bd26ed9;p=vaadin-framework.git

Clarify HierarchicalQuery javadocs
---

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;