Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgroup/enumerable4j
Amazing Ruby's "Enumerable" ported to Java
https://github.com/dgroup/enumerable4j
collection elegantobjects enumerable java java-collections java-collections-framework library ruby ruby-to-java streamex streams streams-api
Last synced: 17 days ago
JSON representation
Amazing Ruby's "Enumerable" ported to Java
- Host: GitHub
- URL: https://github.com/dgroup/enumerable4j
- Owner: dgroup
- License: mit
- Created: 2021-03-06T13:33:28.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-28T19:34:47.000Z (about 1 year ago)
- Last Synced: 2024-10-04T12:45:07.089Z (about 1 month ago)
- Topics: collection, elegantobjects, enumerable, java, java-collections, java-collections-framework, library, ruby, ruby-to-java, streamex, streams, streams-api
- Language: Java
- Homepage:
- Size: 206 KB
- Stars: 29
- Watchers: 4
- Forks: 4
- Open Issues: 14
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING.md
- License: license.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://mvnrepository.com/artifact/io.github.dgroup/enumerable4j)
[](http://www.javadoc.io/doc/io.github.dgroup/enumerable4j)
[](./license.txt)
[](https://github.com/dgroup/enumerable4j/graphs/commit-activity)
[](https://hitsofcode.com/view/github/dgroup/enumerable4j)
[](https://github.com/dgroup/enumerable4j/actions/workflows/build.yml)
[](http://www.0pdd.com/p?name=dgroup/enumerable4j)
[](https://requires.io/github/dgroup/enumerable4j/requirements/?branch=master)
[](https://snyk.io/org/dgroup/project/4a9f3433-7da5-4c24-985e-ee1d3077c458/?tab=dependencies\&vulns=vulnerable)
[](http://www.rultor.com/p/dgroup/enumerable4j)
[](http://www.elegantobjects.org/#principles)
[](https://www.jetbrains.com/idea/)
[](http://www.qulice.com/)
[](https://sonarcloud.io/dashboard?id=dgroup_enumerable4j)
[](https://codebeat.co/projects/github-com-dgroup-enumerable4j-master)
[](https://www.codacy.com/gh/dgroup/enumerable4j/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=dgroup/enumerable4j\&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/dgroup/enumerable4j)
* [Overview](#overview)
* [How to use?](#how-to-use)
* [.all](#all)
* [.any](#any)
* [.none](#none)
* [.select](#select)
* [.map](#map)
* [.count](#count)
* [.reject](#reject)
* [.find](#find)
* [.reduce](#reduce)
* [.after](#after)
* [.next](#next)
* [.chain](#chain)
* [.each](#each)
* [.take](#take)
* [.drop](#drop)
* [.one](#one)
* [.uniq](#uniq)
* [.zip](#zip)
* [How to contribute?](#how-to-contribute)
* [Contributors](#contributors)
### Overview
**enumerable4j** is a Ruby's well known [Enumerable](https://ruby-doc.org/core-2.6/Enumerable.html)
ported to `java` as interface with set of default methods which simplify typical operations with collections.
```java
/**
* The iterable with primitive operations witch simplify typical actions like count, map, etc.
*
* The API is based on Ruby's Enumerable:
* https://ruby-doc.org/core-2.6/Enumerable.html.
*
* The Enumerable provides methods with several traversal and searching features, and with the
* ability to sort. The class must provide a method each, which yields successive members of the
* collection.
*
* @param The type of entities.
* @since 0.1.0
*/
public interface Enumerable extends Collection {
/**
* Passes each element of the collection to the each given function.
* The given null predicates are skipped.
* If no predicate (null) is given, then false is returned instead.
* @param first The function to match each element.
* @param other The array of functions to match each element.
* @return True if the functions never return false.
*/
default boolean all(Predicate first, Predicate... other) {
// ...
}
/**
* Passes at least one element of the collection to the each given function.
* The given null predicates are skipped.
* If no predicate (null) is given, then false is returned instead.
* @param first The function to match at least one element.
* @param other The array of functions to match at least one element.
* @return True if functions never return true at least once.
*/
default boolean any(Predicate first, Predicate... other) {
// ...
}
/**
* Doesn't passes elements of the collection to the each given function.
* The given null predicates are skipped.
* If no predicate (null) is given, then true is returned instead.
* @param first The function to match none elements.
* @param other The array of functions to match none elements.
* @return True if the functions never returns false or nil.
*/
default boolean none(Predicate first, Predicate... other) {
// ...
}
/**
* Returns an enumerable containing all elements of enumerable for which the given functions
* return a true value.
* The given null predicates are skipped.
* If no predicate (null) is given, then an empty enumerable is returned instead.
* @param first The function to match each element.
* @param other The array of functions to match each element.
* @return The enumerable.
*/
default Enumerable select(Predicate first, Predicate... other) {
// ...
}
/**
* Returns an enumerable containing all elements of enumerable for which the given function
* returns a false value.
* The given null predicates are skipped.
* If no predicate (null) is given, then 'this' is returned instead.
* @param first The function to match each element.
* @param other The array of functions to match each element.
* @return The enumerable.
*/
default Enumerable reject(Predicate first, Predicate... other) {
// ...
}
/**
* Returns an enumerable containing first element of enumerable for which the given function
* returns a true value.
* The given null predicates are skipped.
* If no predicate (null) is given, or no element found then null is returned instead.
* @param first The function to match each element.
* @param other The array of functions to match each element.
* @return The first element of enumerable, that matches predicate.
*/
default T find(Predicate first, Predicate... other) {
// ...
}
/**
* Returns an enumerable containing first element of enumerable for which the given function
* returns a true value.
* The given null predicates are skipped.
* If no predicate (null) is given, or no element found then alternative is returned instead.
* @param alt The alternative to return in case of null predicate or no element found.
* @param first The function to match each element.
* @param other The array of functions to match each element.
* @return The first element of enumerable, that matches predicate.
*/
default T find(X alt, Predicate first, Predicate... other) {
// ...
}
/**
* Returns an enumerable containing all elements, on which given function was applied.
* If no function (null) is given, then 'this' is returned instead.
* @param fnc The function to apply to each element.
* @param The type of target entity.
* @return The enumerable.
*/
default Enumerable map(Function super T, ? extends R> fnc) {
// ...
}
/**
* Returns the number of elements that are present in enumerable for which the given
* function return true.
* The given null predicates are skipped.
* If no function (null) is given, then 0 is returned instead.
* @param first The function to match each element.
* @param other The array of functions to match each element.
* @return Number of elements satisfying the given function.
*/
default long count(Predicate first, Predicate... other) {
// ...
}
/**
* Returns a result of the reduction of the elements in this stream,
* using provided identity value and accumulation function operator.
* If no function (null) is given, then identity is returned instead.
* @param idn The identity value of the accumulation function.
* @param opr The accumulation function operator which combining previous and current values.
* @return Result of of combining elements.
*/
default T reduce(T idn, BinaryOperator opr) {
// ...
}
/**
* Returns an enumerable containing all elements of enumerable
* after the first one which corresponds the condition.
* If no predicate (null) is given, then empty enumerable is returned instead.
* @param prd The function to match element after which enumerable elements should be returned.
* @return The enumerable.
*/
default Enumerable after(Predicate prd) {
// ...
}
/**
* Returns an enumerable containing a certain number of elements of enumerable
* after the first one which corresponds the condition.
* If no predicate (null) is given, then empty enumerable is returned instead.
* @param prd The function to match element after which enumerable elements should be returned.
* @param size The number of elements the enumerable should be limited to.
* @return The enumerable.
* @throws IllegalArgumentException If the size is negative.
*/
default Enumerable after(Predicate prd, long size) {
// ...
}
/**
* Returns the next element of enumerable after the first one which corresponds the condition.
* If no predicate (null) is given, or no element found then null is returned instead.
* @param prd The function to match element after which enumerable element should be returned.
* @return The next element of enumerable after the first one which corresponds the condition.
*/
default T next(Predicate prd) {
// ...
}
/**
* Returns the next element of enumerable after the first one which corresponds the condition.
* If no predicate (null) is given, or no element found then alternative is returned instead.
* @param prd The function to match element after which enumerable element should be returned.
* @param alt The alternative to return in case of null predicate or no element found.
* @return The next element of enumerable after the first one which corresponds the condition.
*/
default T next(Predicate prd, T alt) {
// ...
}
/**
* Returns a new enumerable which contains the items of the original collection
* and the added items of the given enumerable.
* If no enumerable (null) is given, then 'this' is returned instead.
* @param enm The given enumerable.
* @return The enumerable.
*/
default Enumerable chain(Enumerable enm) {
// ...
}
/**
* Returns an enumerable consisting of the elements of the collection,
* additionally performing the provided action on each element of the enumerable.
* @param act An action to perform on the elements.
* @return The enumerable.
*/
default Enumerable each(Consumer act) {
// ...
}
/**
* Returns an enumerable containing first elements of specified size from the enumerable.
* @param num The number of elements the enumerable should be limited to.
* @return The enumerable.
* @throws IllegalArgumentException If the size is negative.
*/
default Enumerable take(long num) {
// ...
}
/**
* Drops first elements of specified size,
* and returns an enumerable containing the rest of the elements.
* @param num The number of elements to be dropped.
* @return The enumerable.
* @throws IllegalArgumentException If the size is negative.
*/
default Enumerable drop(long num) {
// ...
}
/**
* The method returns true if the functions return true exactly once.
* The given null predicates are skipped.
* If no predicate (null) is given, then false is returned instead.
* @param first The function to match each element.
* @param other The array of functions to match each element.
* @return True if the functions returns true exactly once.
*/
default boolean one(Predicate first, Predicate... other) {
// ...
}
/**
* Returns a new enumerable containing the unique elements.
* It compares values using the {@link #hashCode} and {@link #equals} methods for efficiency.
* @return The enumerable.
*/
default Enumerable uniq() {
// ...
}
/**
* Returns a new enumerable containing the unique elements which corresponds the condition
* of the given function.
* If no function (null) is given, then empty enumerable is returned instead.
* @param fnc The function to apply to each element.
* @param The type of function result entity.
* @return The enumerable.
*/
default Enumerable uniq(Function super T, ? extends R> fnc) {
// ...
}
/**
* Returns an enumerable of collections which contains each element of original collection
* and corresponding elements from each argument collections.
* The length of the resulting enumerable is {@link Enumerable#size}.
* If the size of any argument is less than {@link Enumerable#size}, null values are supplied.
* @param first The array of enumerable to merge.
* @param other The array of enumerable to merge.
* @return The enumerable.
*/
default Enumerable> zip(Enumerable first, Enumerable... other) {
// ...
}
}
```
See [more](./src/main/java/io/github/dgroup/enumerable4j/Enumerable.java).
### How to use
1. Get the latest version [here](https://github.com/dgroup/enumerable4j/releases):
```xml
io.github.dgroup
enumerable4j
${version}
```
2. Assign the [Enumerable](./src/main/java/io/github/dgroup/enumerable4j/Enumerable.java) interface with default methods to your own collection
```java
/**
* The collection which you implemented in your project for some purposes.
*/
public class YourOwnCollection extends Collection implements Enumerable {
//
}
```
You may (but not required) override the default implementations of methods from [Enumerable](./src/main/java/io/github/dgroup/enumerable4j/Enumerable.java) if needed.
3. Java version required: 1.8+.
4. Comparing matrix with other libs:
enumerable4j (MIT) | Java 8 | [cactoos](https://github.com/yegor256/cactoos) (MIT) | [eclipse-collections]() (EDL)
|------ | ------ | ------ |------ |
`.all(...)` | `.stream().allMatch(...)` | `new And<>(...,...).value()`| tbd |
`.any(...)` | `.stream().anyMatch(...)` | `new Or<>(...,...).value()`| tbd |
`.none(...)` | `.stream().noneMatch(...)` | `new And<>(...,...).value()`| tbd |
`.select(...)` | `.stream().filter(...).collect(Collectors.toList())` | `new Filtered<>(...,...)` | tbd |
`.reject(...)` | `.stream().filter((...).negate()).collect(Collectors.toList())` | `new Filtered<>(...,...)` | tbd |
`.map(...)` | `.stream().map(...).collect(Collectors.toList())` | `new Mapped<>(...,...)` | tbd |
`.count(...)` | `.stream().filter(...).count()` | `new Filtered<>(...).size()` | tbd |
`.find(...)` | `.stream().filter(...).findFirst().orElse(...)` | `new FirstOf<>(...,...).value()` | tbd |
`.reduce(...,...)` | `.stream().reduce(...,...)` | `new Reduced<>(...,...).value()` | tbd |
`.after(...)` | | | tbd |
`.next(...)` | | | tbd |
`.chain(...)` | | | tbd |
`.each(...)` | `.stream().forEach(...)` | `new ForEach<>(...).exec(...)` | tbd |
`.take(...)` | `.stream().limit(...).collect(Collectors.toList())` | `new Sliced<>(0,...,...)` | tbd |
`.drop(...)` | `.stream().skip(...).collect(Collectors.toList())` | `new Sliced<>(...,...,...)`| tbd |
`.one(...)` | `.stream().filter(...).count() == 1` | `new Filtered<>(...).size() == 1` | tbd |
`.uniq(...)` | `.stream().skip(...).collect(Collectors.toSet())` | | tbd |
`.zip(...)` | | | tbd |
#### .all
```java
YourOwnCollection src = ... // with elements [1, 2, 3]
boolean allPositive = src.all(val -> val > 0); // true
```
#### .any
```java
YourOwnCollection src = ... // with elements [-1, 0, 1]
boolean oneIsPositive = src.any(val -> val > 0); // true
```
#### .none
```java
YourOwnCollection src = ... // with elements [-2, -1, 0]
boolean noneIsPositive = src.none(val -> val > 0); // true
```
#### .select
```java
YourOwnCollection src = ... // with elements [-1, 1, 2]
Enumerable positive = src.select(val -> val > 0); // [1, 2]
```
#### .reject
```java
YourOwnCollection src = ... // with elements [-1, 1, 2]
Enumerable negative = src.reject(val -> val > 0); // [-1]
```
#### .map
```java
YourOwnCollection src = ... // with elements [0, 1, 2]
Enumerable positive = src.map(val -> val + 1); // [1, 2, 3]
```
#### .count
```java
YourOwnCollection src = ... // with elements [-1, 0, 1]
long countNegative = src.count(val -> val < 0); // 1
```
#### .find
```java
YourOwnCollection src = ... // with elements [-1, 0, 1]
Integer first = src.find(val -> val > 0); // 1
Integer alternative = src.find(50, val -> val > 5); // 50
```
#### .reduce
```java
YourOwnCollection src = ... // with elements [1, 2, 3]
Integer sum = src.reduce(0, Integer::sum); // 6
```
#### .after
```java
YourOwnCollection src = ... // with elements [2, 3, 4, 5, 6]
Enumerable afterThree = src.after(val -> val == 3); // [4, 5, 6]
Enumerable firstTwoAfterThree = src.after(val -> val == 3, 2); // [4, 5]
```
#### .next
```java
YourOwnCollection src = ... // with elements [1, 2, 3, 4]
Integer next = src.next(val -> val == 2); // 3
Integer alternative = src.next(val -> val > 5, -1); // -1
```
#### .chain
```java
YourOwnCollection src = ... // with elements [1, 2]
Enumerable joined = src.chain(new Linked<>(3)).chain(new Linked<>(4, 5)); // [1, 2, 3, 4, 5]
```
#### .each
```java
YourOwnCollection src = ... // with elements [1, 2, 3]
Enumerable buf = src.each(System.out::print); // [1, 2, 3] , printed: "123"
```
#### .take
```java
YourOwnCollection src = ... // with elements [1, 2, 3]
Enumerable taken = src.take(2); // [1, 2]
```
#### .drop
```java
YourOwnCollection src = ... // with elements [1, 2, 3]
Enumerable taken = src.drop(2); // [3]
```
#### .one
```java
YourOwnCollection src = ... // with elements [-1, 0, 1]
boolean onePositive = src.one(val -> val > 0); // true
```
#### .uniq
```java
YourOwnCollection> src = ... // with elements [[1, 2], [3, 4], [1, 2], [3, 4, 5]]
Enumerable> unique = src.uniq(); // [[1, 2], [3, 4], [3, 4, 5]]
Enumerable> uniqueByKey = src.uniq(enm -> enm.get(0)); // [[1, 2], [3, 4]]
```
#### .zip
```java
YourOwnCollection src = ... // with elements [1, 2, 3]
YourOwnCollection src2 = ... // with elements [4, 5, 6]
Enumerable> zip = src.zip(src2); // [[1, 4]], [2, 5], [3, 6]]
```
### How to contribute?
[](http://www.elegantobjects.org/#principles)
1. Pull requests are welcome! Don't forget to add your name to contribution section and run this,
beforehand:
```bash
mvn -Pqulice clean install
```
2. Everyone interacting in this project’s codebases, issue trackers, chat rooms is expected to
follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
3. Latest maven coordinates [here](https://github.com/dgroup/enumerable4j/releases):
```xml
io.github.dgroup
enumerable4j
${version}
```
### Contributors
* [dgroup](https://github.com/dgroup) as Yurii Dubinka ()
* [smithros](https://github.com/smithros) as Rostyslav Koval ()
* [ashutosh](https://github.com/singhashutosh96) as Ashutosh Singh ()
* [dykov](https://github.com/dykov) as Oleksii Dykov ()