Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2022 Goldman Sachs and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompany this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.eclipse.collections.api;
import java.util.Collection;
import java.util.NoSuchElementException;
import java.util.IntSummaryStatistics;
import java.util.Comparator;
import org.eclipse.collections.api.block.comparator.primitive.CharComparator;
import org.eclipse.collections.api.bag.primitive.MutableCharBag;
import org.eclipse.collections.api.block.function.primitive.CharToBooleanFunction;
import org.eclipse.collections.api.block.function.primitive.CharToByteFunction;
import org.eclipse.collections.api.block.function.primitive.CharToShortFunction;
import org.eclipse.collections.api.block.function.primitive.CharToCharFunction;
import org.eclipse.collections.api.block.function.primitive.CharToDoubleFunction;
import org.eclipse.collections.api.block.function.primitive.CharToFloatFunction;
import org.eclipse.collections.api.block.function.primitive.CharToIntFunction;
import org.eclipse.collections.api.block.function.primitive.CharToLongFunction;
import org.eclipse.collections.api.block.function.primitive.CharToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.BooleanCharToBooleanFunction;
import org.eclipse.collections.api.block.function.primitive.ByteCharToByteFunction;
import org.eclipse.collections.api.block.function.primitive.CharCharToCharFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleCharToDoubleFunction;
import org.eclipse.collections.api.block.function.primitive.FloatCharToFloatFunction;
import org.eclipse.collections.api.block.function.primitive.IntCharToIntFunction;
import org.eclipse.collections.api.block.function.primitive.LongCharToLongFunction;
import org.eclipse.collections.api.block.function.primitive.ObjectCharToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.ShortCharToShortFunction;
import org.eclipse.collections.api.block.predicate.primitive.CharPredicate;
import org.eclipse.collections.api.block.procedure.primitive.CharProcedure;
import org.eclipse.collections.api.collection.primitive.MutableBooleanCollection;
import org.eclipse.collections.api.collection.primitive.MutableByteCollection;
import org.eclipse.collections.api.collection.primitive.MutableCharCollection;
import org.eclipse.collections.api.collection.primitive.MutableDoubleCollection;
import org.eclipse.collections.api.collection.primitive.MutableFloatCollection;
import org.eclipse.collections.api.collection.primitive.MutableIntCollection;
import org.eclipse.collections.api.collection.primitive.MutableLongCollection;
import org.eclipse.collections.api.collection.primitive.MutableShortCollection;
import org.eclipse.collections.api.iterator.CharIterator;
import org.eclipse.collections.api.list.primitive.MutableCharList;
import org.eclipse.collections.api.set.primitive.CharSet;
import org.eclipse.collections.api.set.primitive.MutableCharSet;
/**
* CharIterable is an interface which is memory-optimized for char primitives.
* It is inspired by the interface RichIterable, and contains a subset of the internal iterator methods on RichIterable like collect, sum, etc.
* The API also includes an external iterator method, which returns an CharIterator. CharIterator helps iterate over the CharIterable without boxing the primitives.
* This file was automatically generated from template file primitiveIterable.stg.
*/
public interface CharIterable extends PrimitiveIterable
{
/**
* Returns a primitive iterator that can be used to iterate over the CharIterable in an
* imperative style.
*/
CharIterator charIterator();
/**
* Converts the CharIterable to a primitive char array.
*/
char[] toArray();
/**
* Converts the CharIterable to a primitive char array. If the collection fits into the provided array it is used
* to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated
* and returned. If the iterable is empty, the target array is returned unchanged.
*/
default char[] toArray(char[] target)
{
return this.toList().toArray(target);
}
/**
* Returns true if the value is contained in the CharIterable, and false if it is not.
*/
boolean contains(char value);
/**
* Returns true if all of the values specified in the source array are contained
* in the CharIterable, and false if they are not.
*/
default boolean containsAll(char... source)
{
if (this.size() <= 32 || source.length < 4)
{
for (char item : source)
{
if (!this.contains(item))
{
return false;
}
}
return true;
}
else
{
CharSet set = this instanceof CharSet ? (CharSet) this : this.toSet();
for (char item : source)
{
if (!set.contains(item))
{
return false;
}
}
return true;
}
}
/**
* Returns true if all of the values specified in the source CharIterable are contained
* in the CharIterable, and false if they are not.
*/
default boolean containsAll(CharIterable source)
{
if (this.size() <= 32 || source.size() < 4)
{
return source.allSatisfy(this::contains);
}
else
{
CharSet set = this instanceof CharSet ? (CharSet) this : this.toSet();
return source.allSatisfy(set::contains);
}
}
/**
* Returns true if any of the values specified in the source array are contained
* in the CharIterable, and false if they are not.
*
* @since 11.0
*/
default boolean containsAny(char... source)
{
CharIterable inside = this;
if (this.size() > 32 && source.length > 32 && !(this instanceof CharSet))
{
inside = this.toSet();
}
for (int i = 0; i < source.length; i++)
{
if (inside.contains(source[i]))
{
return true;
}
}
return false;
}
/**
* Returns true if any of the values specified in the source CharIterable are contained
* in the CharIterable, and false if they are not.
*
* @since 11.0
*/
default boolean containsAny(CharIterable source)
{
CharIterable outside = this;
CharIterable inside = source;
if (this.size() < source.size())
{
outside = source;
inside = this;
}
if (outside instanceof CharSet)
{
CharIterable temp = outside;
outside = inside;
inside = temp;
}
else if (inside.size() > 32 && !(inside instanceof CharSet))
{
inside = inside.toSet();
}
return outside.anySatisfy(inside::contains);
}
/**
* Returns true if none of the values specified in the source array are contained
* in the CharIterable, and false if they are.
*
* @since 11.0
*/
default boolean containsNone(char... source)
{
CharIterable inside = this;
if (this.size() > 32 && source.length > 32 && !(this instanceof CharSet))
{
inside = this.toSet();
}
for (int i = 0; i < source.length; i++)
{
if (inside.contains(source[i]))
{
return false;
}
}
return true;
}
/**
* Returns true if none of the values specified in the source CharIterable are contained
* in the CharIterable, and false if they are.
*
* @since 11.0
*/
default boolean containsNone(CharIterable source)
{
CharIterable outside = this;
CharIterable inside = source;
if (this.size() < source.size())
{
outside = source;
inside = this;
}
if (outside instanceof CharSet)
{
CharIterable temp = outside;
outside = inside;
inside = temp;
}
else if (inside.size() > 32 && !(inside instanceof CharSet))
{
inside = inside.toSet();
}
return outside.noneSatisfy(inside::contains);
}
/**
* Applies the CharProcedure to each element in the CharIterable.
*/
default void forEach(CharProcedure procedure)
{
this.each(procedure);
}
/**
* A synonym for forEach.
*
* @since 7.0.
*/
void each(CharProcedure procedure);
/**
* @since 9.0.
*/
default CharIterable tap(CharProcedure procedure)
{
this.forEach(procedure);
return this;
}
/**
* Returns a new CharIterable with all of the elements in the CharIterable that
* return true for the specified predicate.
*/
CharIterable select(CharPredicate predicate);
/**
* Returns a new CharIterable with all of the elements in the CharIterable that
* return false for the specified predicate.
*/
CharIterable reject(CharPredicate predicate);
/**
* Same as {@link #select(CharPredicate)} , only the results are added to the target MutableCharCollection.
*
* @since 8.1.
*/
default R select(CharPredicate predicate, R target)
{
this.each(each ->
{
if (predicate.accept(each))
{
target.add(each);
}
});
return target;
}
/**
* Same as {@link #reject(CharPredicate)} , only the results are added to the target MutableCharCollection.
*
* @since 8.1.
*/
default R reject(CharPredicate predicate, R target)
{
this.each(each ->
{
if (!predicate.accept(each))
{
target.add(each);
}
});
return target;
}
/**
* Returns a new collection with the results of applying the specified function on each element of the source
* collection. This method is also commonly called transform or map.
*/
RichIterable collect(CharToObjectFunction function);
/**
* Same as {@link #collect(CharToObjectFunction)} , only the results are added to the target Collection.
*
* @since 8.1.
*/
default > R collect(CharToObjectFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* {@code flatCollect} is a special case of {@link #collect(CharToObjectFunction)}. With {@code collect}, when the {@link CharToObjectFunction} returns
* a collection, the result is a collection of collections. {@code flatCollect} outputs a single "flattened" collection
* instead. This method is commonly called flatMap.
*
* @since 8.1.
*/
default > R flatCollect(CharToObjectFunction> function, R target)
{
this.each(each ->
{
Iterable iterable = function.valueOf(each);
if (iterable instanceof Collection)
{
target.addAll((Collection) iterable);
}
else
{
iterable.forEach(target::add);
}
});
return target;
}
/**
* Returns the target {@code MutableBooleanCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectBoolean(CharToBooleanFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* Returns the target {@code MutableByteCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectByte(CharToByteFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* Returns the target {@code MutableCharCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectChar(CharToCharFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* Returns the target {@code MutableShortCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectShort(CharToShortFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* Returns the target {@code MutableIntCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectInt(CharToIntFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* Returns the target {@code MutableFloatCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectFloat(CharToFloatFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* Returns the target {@code MutableLongCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectLong(CharToLongFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
/**
* Returns the target {@code MutableDoubleCollection} with the results of applying the specified function on each element
* of the source collection.
*
* @since 8.1.
*/
default R collectDouble(CharToDoubleFunction function, R target)
{
this.each(each -> target.add(function.valueOf(each)));
return target;
}
char detectIfNone(CharPredicate predicate, char ifNone);
/**
* Returns a count of the number of elements in the CharIterable that return true for the
* specified predicate.
*/
int count(CharPredicate predicate);
/**
* Returns true if any of the elements in the CharIterable return true for the
* specified predicate, otherwise returns false.
*/
boolean anySatisfy(CharPredicate predicate);
/**
* Returns true if all of the elements in the CharIterable return true for the
* specified predicate, otherwise returns false.
*/
boolean allSatisfy(CharPredicate predicate);
/**
* Returns true if none of the elements in the CharIterable return true for the
* specified predicate, otherwise returns false.
*/
default boolean noneSatisfy(CharPredicate predicate)
{
return !this.anySatisfy(predicate);
}
/**
* Converts the CharIterable to a new MutableCharList.
*/
MutableCharList toList();
/**
* Converts the CharIterable to a new MutableCharSet.
*/
MutableCharSet toSet();
/**
* Converts the CharIterable to a new MutableCharBag.
*/
MutableCharBag toBag();
/**
* Returns a LazyCharIterable adapter wrapping the source CharIterable.
*/
LazyCharIterable asLazy();
T injectInto(T injectedValue, ObjectCharToObjectFunction function);
/**
* Returns the final boolean 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default boolean injectIntoBoolean(boolean injectedValue, BooleanCharToBooleanFunction function)
{
boolean[] result = new boolean[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* Returns the final byte 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default byte injectIntoByte(byte injectedValue, ByteCharToByteFunction function)
{
byte[] result = new byte[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* Returns the final char 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default char injectIntoChar(char injectedValue, CharCharToCharFunction function)
{
char[] result = new char[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* Returns the final short 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default short injectIntoShort(short injectedValue, ShortCharToShortFunction function)
{
short[] result = new short[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* Returns the final int 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default int injectIntoInt(int injectedValue, IntCharToIntFunction function)
{
int[] result = new int[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* Returns the final float 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default float injectIntoFloat(float injectedValue, FloatCharToFloatFunction function)
{
float[] result = new float[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* Returns the final long 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default long injectIntoLong(long injectedValue, LongCharToLongFunction function)
{
long[] result = new long[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* Returns the final double 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
* item in the iterable is used as the second parameter.
*
* @since 11.1
*/
default double injectIntoDouble(double injectedValue, DoubleCharToDoubleFunction function)
{
double[] result = new double[1];
result[0] = injectedValue;
this.each(each ->
{
result[0] = function.valueOf(result[0], each);
});
return result[0];
}
/**
* @see #reduce(LongCharToLongFunction)
*
* @since 10.0
*/
default long reduceIfEmpty(LongCharToLongFunction accumulator, long defaultValue)
{
if (this.isEmpty())
{
return defaultValue;
}
else
{
return this.reduce(accumulator);
}
}
/**
* @see RichIterable#reduce(BinaryOperator)
*
* @since 10.0
*/
default long reduce(LongCharToLongFunction accumulator)
{
boolean[] seenOne = new boolean[1];
long[] result = new long[1];
this.each(each ->
{
if (seenOne[0])
{
result[0] = accumulator.valueOf(result[0], each);
}
else
{
seenOne[0] = true;
result[0] = (long) each;
}
});
if (!seenOne[0])
{
throw new NoSuchElementException();
}
else
{
return result[0];
}
}
/**
* Partitions elements in fixed size chunks.
*
* @param size the number of elements per chunk
*
* @return A {@code RichIterable} containing {@code CharIterable}s of size {@code size}, except the last will be
* truncated if the elements don't divide evenly.
*
* @since 9.2
*/
default RichIterable chunk(int size)
{
throw new UnsupportedOperationException("Default method to prevent breaking backwards compatibility");
}
long sum();
/**
* @since 8.0
*/
default IntSummaryStatistics summaryStatistics()
{
IntSummaryStatistics stats = new IntSummaryStatistics();
this.forEach(stats::accept);
return stats;
}
char max();
char maxIfEmpty(char defaultValue);
char min();
char minIfEmpty(char defaultValue);
double average();
/**
* @since 9.0
*/
default double averageIfEmpty(double defaultValue)
{
if (this.isEmpty())
{
return defaultValue;
}
return this.average();
}
double median();
/**
* @since 9.0
*/
default double medianIfEmpty(double defaultValue)
{
if (this.isEmpty())
{
return defaultValue;
}
return this.median();
}
char[] toSortedArray();
MutableCharList toSortedList();
/**
* Converts the collection to a MutableCharList implementation sorted using the provided comparator.
*/
default MutableCharList toSortedList(CharComparator comparator)
{
return this.toList().sortThis(comparator);
}
/**
* Converts the collection to a MutableCharListImplementation sorted based on the natural order of the key returned
* by {@code function}.
*/
default MutableCharList toSortedListBy(CharToObjectFunction function)
{
return this.toList().sortThisBy(function);
}
/**
* Converts the collection to a MutableCharList implementation, which is sorted based on the key returned by
* {@code function} using the provided {@code comparator}.
*/
default MutableCharList toSortedListBy(CharToObjectFunction function, Comparator comparator)
{
return this.toList().sortThisBy(function, comparator);
}
}
