Skip to content

Commit

Permalink
Shorten category names and add emojis.
Browse files Browse the repository at this point in the history
  • Loading branch information
donraab committed Sep 24, 2024
1 parent 04e7eee commit c73084a
Showing 1 changed file with 29 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,18 @@
* Links are provided below as a convenience to help discover specific methods in Javadoc.
*
* <ul>
* <li><b>Iterating Methods</b>
* <li><b>Iterating πŸ”„</b>
* <ul><li>
* {@link #each(Procedure)}, {@link #forEach(Procedure)}, {@link #forEachWith(Procedure2, Object)},
* {@link #forEachWithIndex(ObjectIntProcedure)}, {@link #tap(Procedure)}, {@link #asLazy()}, {@link #iterator()},
* {@link #spliterator()}
* </ul></li>
* <li><b>Counting Methods</b>
* <li><b>Counting πŸ”’</b>
* <ul><li>
* {@link #count(Predicate)} , {@link #countBy(Function)} , {@link #countByEach(Function)},
* {@link #countByWith(Function2, Object)}, {@link #countWith(Predicate2, Object)} , {@link #size()}
* </li></ul>
* <li><b>Testing Methods</b>
* <li><b>Testing πŸ§ͺ</b>
* <ul><li>
* {@link #anySatisfy(Predicate)}, {@link #anySatisfyWith(Predicate2, Object)}, {@link #noneSatisfy(Predicate)},
* {@link #noneSatisfyWith(Predicate2, Object)}, {@link #allSatisfy(Predicate)}, {@link #allSatisfyWith(Predicate2, Object)},
Expand All @@ -123,7 +123,7 @@
* {@link #containsBy(Function, Object)},
* {@link #isEmpty()}, {@link #notEmpty()}
* </li></ul>
* <li><b>Finding Methods</b>
* <li><b>Finding πŸ”Ž</b>
* <ul><li>
* {@link #detect(Predicate)}, {@link #detectIfNone(Predicate, Function0)} ,
* {@link #detectWith(Predicate2, Object)}, {@link #detectWithIfNone(Predicate2, Object, Function0)},
Expand All @@ -133,13 +133,13 @@
* {@link #minBy(Function)}, {@link #minByOptional(Function)}, {@link #minOptional()}
* {@link #maxBy(Function)}, {@link #maxByOptional(Function)}, {@link #maxOptional()}
* </li></ul>
* <li><b>Filtering Methods</b>
* <li><b>Filtering 🚰</b>
* <ul><li>
* {@link #select(Predicate)}, {@link #selectInstancesOf(Class)}, {@link #selectWith(Predicate2, Object)},
* {@link #reject(Predicate)}, {@link #rejectWith(Predicate2, Object)} ,
* {@link #partition(Predicate)}, {@link #partitionWith(Predicate2, Object)}
* </li></ul>
* <li><b>Transforming Methods</b>
* <li><b>Transforming πŸ¦‹</b>
* <ul><li>
* {@link #collect(Function)}, {@link #collectIf(Predicate, Function)}, {@link #collectWith(Function2, Object)},
* {@link #collectBoolean(BooleanFunction)}, {@link #collectByte(ByteFunction)}, {@link #collectChar(CharFunction)},
Expand All @@ -152,12 +152,12 @@
* {@link #flatCollectLong(Function, MutableLongCollection)}, {@link #flatCollectShort(Function, MutableShortCollection)} ,
* {@link #zip(Iterable)}, {@link #zipWithIndex(Collection)}
* </li></ul>
* <li><b>Grouping Methods</b>
* <li><b>Grouping 🏘️</b>
* <ul><li>
* {@link #chunk(int)} , {@link #groupBy(Function)} , {@link #groupByAndCollect(Function, Function, MutableMultimap)} ,
* {@link #groupByEach(Function)} , {@link #groupByUniqueKey(Function)}
* </li></ul>
* <li><b>Aggregating Methods</b>
* <li><b>Aggregating πŸ“Š</b>
* <ul><li>
* {@link #aggregateBy(Function, Function0, Function2)} , {@link #aggregateInPlaceBy(Function, Function0, Procedure2)} ,
* {@link #injectInto(Object, Function2)} ,
Expand All @@ -171,7 +171,7 @@
* {@link #summarizeDouble(DoubleFunction)}, {@link #summarizeFloat(FloatFunction)},
* {@link #summarizeInt(IntFunction)}, {@link #summarizeLong(LongFunction)}
* </li></ul>
* <li><b>Converting Methods</b>
* <li><b>Converting πŸ”Œ</b>
* <ul><li>
* {@link #into(Collection)}, {@link #appendString(Appendable)}, {@link #makeString()}, {@link #toString()},
* {@link #toArray()}, {@link #toBag()}, {@link #toBiMap(Function, Function)}, {@link #toList()} ,
Expand All @@ -191,7 +191,7 @@
public interface RichIterable<T>
extends InternalIterable<T>
{
//region [Category: Iterating Methods]
//region [Category: Iterating] πŸ”„

@Override
default void forEach(Procedure<? super T> procedure)
Expand Down Expand Up @@ -238,9 +238,9 @@ default void forEach(Procedure<? super T> procedure)
*/
LazyIterable<T> asLazy();

//endregion [Category: Iterating Methods]
//endregion [Category: Iterating] πŸ”„

//region [Category: Counting Methods]
//region [Category: Counting] πŸ”’

/**
* Returns the number of items in this iterable.
Expand Down Expand Up @@ -337,9 +337,9 @@ default <V, R extends MutableBagIterable<V>> R countByEach(Function<? super T, ?
return this.flatCollect(function, target);
}

//endregion [Category: Counting Methods]
//endregion [Category: Counting] πŸ”’

//region [Category: Testing Methods]
//region [Category: Testing] πŸ§ͺ

/**
* Returns true if this iterable has zero items.
Expand Down Expand Up @@ -532,9 +532,9 @@ else if (inside.size() > 32 && !(inside instanceof SetIterable))
*/
<P> boolean noneSatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter);

//endregion [Category: Testing Methods]
//endregion [Category: Testing] πŸ§ͺ

//region [Category: Finding Methods]
//region [Category: Finding] πŸ”Ž

/**
* Returns any element of an iterable.
Expand Down Expand Up @@ -823,9 +823,9 @@ default <V extends Comparable<? super V>> Optional<T> maxByOptional(Function<? s
return Optional.of(this.maxBy(function));
}

//endregion [Category: Finding Methods]
//endregion [Category: Finding] πŸ”Ž

//region [Category: Filtering Methods]
//region [Category: Filtering] 🚰

/**
* Returns all elements of the source collection that return true when evaluating the predicate. This method is also
Expand Down Expand Up @@ -1013,9 +1013,9 @@ <P, R extends Collection<T>> R rejectWith(
*/
<P> PartitionIterable<T> partitionWith(Predicate2<? super T, ? super P> predicate, P parameter);

//endregion [Category: Filtering Methods]
//endregion [Category: Filtering] 🚰

//region [Category: Transforming Methods]
//region [Category: Transforming] πŸ¦‹

/**
* Returns a new collection with the results of applying the specified function on each element of the source
Expand Down Expand Up @@ -1613,9 +1613,10 @@ default <R extends MutableBooleanCollection> R flatCollectBoolean(Function<? sup
@Deprecated
<R extends Collection<Pair<T, Integer>>> R zipWithIndex(R target);

//endregion [Category: Transforming Methods]
//endregion [Category: Transforming] πŸ¦‹

//region [Category: Grouping] 🏘️

//region [Category: Grouping Methods]
/**
* For each element of the iterable, the function is evaluated and the results of these evaluations are collected
* into a new multimap, where the transformed value is the key and the original values are added to the same (or similar)
Expand Down Expand Up @@ -1719,9 +1720,10 @@ default <K, V, R extends MutableMultimap<K, V>> R groupByAndCollect(
return target;
}

//endregion [Category: Grouping Methods]
//endregion [Category: Grouping] 🏘️

//region [Category: Aggregating] πŸ“Š

//region [Category: Aggregating Methods]
/**
* Returns the final result of evaluating function using each element of the iterable and the previous evaluation
* result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current
Expand Down Expand Up @@ -2108,9 +2110,9 @@ default <K, R extends MutableMapIterable<K, T>> R reduceBy(
return target;
}

//endregion Category: Aggregating Methods
//endregion [Category: Aggregating] πŸ“Š

//region [Category: Converting Methods]
//region [Category: Converting] πŸ”Œ

/**
* Adds all the elements in this iterable to the specific target Collection.
Expand Down Expand Up @@ -2549,5 +2551,5 @@ default void appendString(Appendable appendable, String separator)
*/
void appendString(Appendable appendable, String start, String separator, String end);

//endregion [Category: Converting Methods]
//endregion [Category: Converting] πŸ”Œ
}

0 comments on commit c73084a

Please sign in to comment.