ArrayEvery
Used to iterate over an array and test whether every item meets the test callback.
The function will be passed 3 arguments: the value, the index, and the array. You can alternatively pass a Java Predicate which will only receive the 1st arg. The function should return true if the item meets the test, and false otherwise.
Note: This operation is a short-circuit operation, meaning it will stop iterating as soon as it finds the first item that does not meet the test condition.
Parallel Execution
If the parallel argument is set to true, and no max_threads are sent, the filter will be executed in parallel using a ForkJoinPool with parallel streams.
If max_threads is specified, it will create a new ForkJoinPool with the specified number of threads to run the filter in parallel, and destroy it after the operation is complete.
This allows for efficient processing of large arrays, especially when the test function is computationally expensive or the array is large.
Method Signature
ArrayEvery(array=[array], callback=[function:Predicate], parallel=[boolean], maxThreads=[integer])Arguments
array
array
true
The array to test against the callback.
callback
function:Predicate
true
The function to invoke for each item. The function will be passed 3 arguments: the value, the index, the array. You can alternatively pass a Java Predicate which will only receive the 1st arg.
parallel
boolean
false
Whether to run the filter in parallel. Defaults to false. If true, the filter will be run in parallel using a ForkJoinPool.
false
maxThreads
integer
false
The maximum number of threads to use when running the filter in parallel. If not passed it will use the default number of threads for the ForkJoinPool. If parallel is false, this argument is ignored.
Examples
Example for positive result
Checks whether all items in an array are greater than 2 and outputs true because all of them fulfill the requirement.
array = [
4,
5,
6,
7
];
writeOutput( arrayEvery( array, ( Any value ) => {
return value > 2;
} ) );
Result: true
Example for negative result
Checks whether all items in an array are greater than 2 and outputs false because some of them do not fulfill the requirement.
array = [
1,
2,
3,
4
];
writeOutput( arrayEvery( array, ( Any value ) => {
return value > 2;
} ) );
Result: false
Additional Examples
my_array = [
{
NAME : "Frank",
AGE : 40
},
{
NAME : "Sue",
AGE : 21
},
{
NAME : "Jose",
AGE : 54
}
];
all_old = my_array.every( ( Any person ) => {
return person.AGE >= 40;
}, true, 5 );
dump( all_old );
// false
Related
Last updated
Was this helpful?