Added javadocs

Author: guy120494

src/main/java/graphql/annotations/connection/EnhancedConnectionFetcher.java

@@ -20,6 +20,14 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Use this class in {@link GraphQLConnection} to do a real pagination,
+ * i.e you fetch each time the relevant data, you make the cursors and
+ * you decide if there are previous or next pages
+ *
+ * Note: If you are using the connection, the relevant dataFetcher must implements {@link PaginationDataFetcher}
+ * @param <T> the entity type that is paginated
+ */
 public class EnhancedConnectionFetcher<T> implements ConnectionFetcher<Connection<T>> {
 
     private PaginationDataFetcher<T> paginationDataFetcher;

src/main/java/graphql/annotations/connection/PaginationDataFetcher.java

@@ -18,11 +18,32 @@
 
 import java.util.List;
 
+/**
+ * When use connection with {@link EnhancedConnectionFetcher}, the dataFetcher
+ * must implements this interface
+ * @param <T> the type of the entity that is fetched
+ */
 public interface PaginationDataFetcher<T> extends DataFetcher<List<T>> {
 
+    /**
+     * decides whether this is the last page
+     * @param lastCursor the cursor of the last entity that was fetched
+     * @return true if there is a next page, o.w false
+     */
     boolean hasNextPage(String lastCursor);
 
+    /**
+     * decides whether this is the first page
+     * @param firstCursor the cursor of the first entity that was fetched
+     * @return true if there is a previous page, o.w false
+     */
     boolean hasPreviousPage(String firstCursor);
 
+    /**
+     * get the cursor of the entity. This method is called when the edges are built.
+     * This method is called for every entity that was fetched
+     * @param entity the fetched entity (one of them)
+     * @return the cursor of the entity
+     */
     String getCursor(T entity);
 }