You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by su...@apache.org on 2020/10/23 23:24:31 UTC

[groovy] branch GROOVY-8258 updated: GROOVY-8258: tweak javadoc

This is an automated email from the ASF dual-hosted git repository.

sunlan pushed a commit to branch GROOVY-8258
in repository https://gitbox.apache.org/repos/asf/groovy.git


The following commit(s) were added to refs/heads/GROOVY-8258 by this push:
     new d3de281  GROOVY-8258: tweak javadoc
d3de281 is described below

commit d3de281f02258141bf7e44bf46d8a7b14be78031
Author: Daniel Sun <su...@apache.org>
AuthorDate: Sat Oct 24 07:24:21 2020 +0800

    GROOVY-8258: tweak javadoc
---
 .../groovy/ginq/provider/collection/Queryable.java | 30 +++++++++++-----------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/subprojects/groovy-ginq/src/main/groovy/org/apache/groovy/ginq/provider/collection/Queryable.java b/subprojects/groovy-ginq/src/main/groovy/org/apache/groovy/ginq/provider/collection/Queryable.java
index 2231051..07b4905 100644
--- a/subprojects/groovy-ginq/src/main/groovy/org/apache/groovy/ginq/provider/collection/Queryable.java
+++ b/subprojects/groovy-ginq/src/main/groovy/org/apache/groovy/ginq/provider/collection/Queryable.java
@@ -74,7 +74,7 @@ public interface Queryable<T> {
     }
 
     /**
-     * Inner join another {@link Queryable} instance
+     * Inner join another {@link Queryable} instance, similar to SQL's {@code inner join}
      *
      * @param queryable another {@link Queryable} instance
      * @param joiner join condition
@@ -85,7 +85,7 @@ public interface Queryable<T> {
     <U> Queryable<Tuple2<T, U>> innerJoin(Queryable<? extends U> queryable, BiPredicate<? super T, ? super U> joiner);
 
     /**
-     * Left join another {@link Queryable} instance
+     * Left join another {@link Queryable} instance, similar to SQL's {@code left join}
      *
      * @param queryable another {@link Queryable} instance
      * @param joiner join condition
@@ -96,7 +96,7 @@ public interface Queryable<T> {
     <U> Queryable<Tuple2<T, U>> leftJoin(Queryable<? extends U> queryable, BiPredicate<? super T, ? super U> joiner);
 
     /**
-     * Right join another {@link Queryable} instance
+     * Right join another {@link Queryable} instance, similar to SQL's {@code right join}
      *
      * @param queryable another {@link Queryable} instance
      * @param joiner join condition
@@ -107,7 +107,7 @@ public interface Queryable<T> {
     <U> Queryable<Tuple2<T, U>> rightJoin(Queryable<? extends U> queryable, BiPredicate<? super T, ? super U> joiner);
 
     /**
-     * Full join another {@link Queryable} instance
+     * Full join another {@link Queryable} instance, similar to SQL's {@code full join}
      *
      * @param queryable another {@link Queryable} instance
      * @param joiner join condition
@@ -122,7 +122,7 @@ public interface Queryable<T> {
     }
 
     /**
-     * Cross join another {@link Queryable} instance
+     * Cross join another {@link Queryable} instance, similar to SQL's {@code cross join}
      *
      * @param queryable another {@link Queryable} instance
      * @param <U> the type of element from another {@link Queryable} instance
@@ -132,7 +132,7 @@ public interface Queryable<T> {
     <U> Queryable<Tuple2<T, U>> crossJoin(Queryable<? extends U> queryable);
 
     /**
-     * Filter {@link Queryable} instance via some condition
+     * Filter {@link Queryable} instance via some condition, similar to SQL's {@code where}
      *
      * @param filter the filter condition
      * @return filter result
@@ -141,7 +141,7 @@ public interface Queryable<T> {
     Queryable<T> where(Predicate<? super T> filter);
 
     /**
-     * Group by {@link Queryable} instance
+     * Group by {@link Queryable} instance, similar to SQL's {@code group by}
      *
      * @param classifier the classifier for group by
      * @param having the filter condition
@@ -152,7 +152,7 @@ public interface Queryable<T> {
     <K> Queryable<Tuple2<K, Queryable<T>>> groupBy(Function<? super T, ? extends K> classifier, Predicate<? super Tuple2<? extends K, Queryable<? extends T>>> having);
 
     /**
-     * Group by {@link Queryable} instance without {@code having} clause
+     * Group by {@link Queryable} instance without {@code having} clause, similar to SQL's {@code group by}
      *
      * @param classifier the classifier for group by
      * @param <K> the type of group key
@@ -164,7 +164,7 @@ public interface Queryable<T> {
     }
 
     /**
-     * Sort {@link Queryable} instance
+     * Sort {@link Queryable} instance, similar to SQL's {@code order by}
      *
      * @param orders the order rules for sorting
      * @param <U> the type of field to sort
@@ -195,7 +195,7 @@ public interface Queryable<T> {
     }
 
     /**
-     * Project {@link Queryable} instance
+     * Project {@link Queryable} instance, similar to SQL's {@code select}
      *
      * @param mapper project fields
      * @param <U> the type of project record
@@ -205,7 +205,7 @@ public interface Queryable<T> {
     <U> Queryable<U> select(Function<? super T, ? extends U> mapper);
 
     /**
-     * Eliminate duplicated records
+     * Eliminate duplicated records, similar to SQL's {@code distinct}
      *
      * @return the distinct result
      * @since 4.0.0
@@ -213,7 +213,7 @@ public interface Queryable<T> {
     Queryable<T> distinct();
 
     /**
-     * Union another {@link Queryable} instance
+     * Union another {@link Queryable} instance, similar to SQL's {@code union}
      *
      * @param queryable the other {@link Queryable} instance
      * @return the union result
@@ -224,7 +224,7 @@ public interface Queryable<T> {
     }
 
     /**
-     * Union all another {@link Queryable} instance
+     * Union all another {@link Queryable} instance, similar to SQL's {@code union all}
      *
      * @param queryable the other {@link Queryable} instance
      * @return the union all result
@@ -233,7 +233,7 @@ public interface Queryable<T> {
     Queryable<T> unionAll(Queryable<? extends T> queryable);
 
     /**
-     * Intersect another {@link Queryable} instance
+     * Intersect another {@link Queryable} instance, similar to SQL's {@code intersect}
      *
      * @param queryable the other {@link Queryable} instance
      * @return the intersect result
@@ -242,7 +242,7 @@ public interface Queryable<T> {
     Queryable<T> intersect(Queryable<? extends T> queryable);
 
     /**
-     * Minus another {@link Queryable} instance
+     * Minus another {@link Queryable} instance, similar to SQL's {@code minus}
      *
      * @param queryable the other {@link Queryable} instance
      * @return the minus result