Package org.eclipse.collections.api
Interface ByteIterable
- All Superinterfaces:
PrimitiveIterable
- All Known Subinterfaces:
ByteBag
,ByteByteMap
,ByteList
,ByteSet
,ByteStack
,ByteValuesMap
,CharByteMap
,DoubleByteMap
,FloatByteMap
,ImmutableByteBag
,ImmutableByteByteMap
,ImmutableByteCollection
,ImmutableByteList
,ImmutableByteSet
,ImmutableByteStack
,ImmutableCharByteMap
,ImmutableDoubleByteMap
,ImmutableFloatByteMap
,ImmutableIntByteMap
,ImmutableLongByteMap
,ImmutableObjectByteMap<K>
,ImmutableShortByteMap
,IntByteMap
,LazyByteIterable
,LongByteMap
,MutableByteBag
,MutableByteByteMap
,MutableByteCollection
,MutableByteList
,MutableByteSet
,MutableByteStack
,MutableByteValuesMap
,MutableCharByteMap
,MutableDoubleByteMap
,MutableFloatByteMap
,MutableIntByteMap
,MutableLongByteMap
,MutableObjectByteMap<K>
,MutableShortByteMap
,ObjectByteMap<K>
,OrderedByteIterable
,ReversibleByteIterable
,ShortByteMap
- All Known Implementing Classes:
AbstractByteIterable
,AbstractByteSet
,AbstractByteStack
,AbstractImmutableByteSet
,AbstractImmutableObjectByteMap
,AbstractLazyByteIterable
,AbstractMutableByteKeySet
,AbstractMutableByteValuesMap
,AbstractSynchronizedByteCollection
,AbstractUnmodifiableByteCollection
,ByteArrayList
,ByteArrayStack
,ByteByteHashMap
,ByteHashBag
,ByteHashSet
,CharByteHashMap
,CollectBooleanToByteIterable
,CollectByteIterable
,CollectByteToByteIterable
,CollectCharToByteIterable
,CollectDoubleToByteIterable
,CollectFloatToByteIterable
,CollectIntToByteIterable
,CollectLongToByteIterable
,CollectShortToByteIterable
,DoubleByteHashMap
,FloatByteHashMap
,IntByteHashMap
,LazyByteIterableAdapter
,LongByteHashMap
,ObjectByteHashMap
,ObjectByteHashMapWithHashingStrategy
,ReverseByteIterable
,SelectByteIterable
,ShortByteHashMap
,SynchronizedByteBag
,SynchronizedByteByteMap
,SynchronizedByteCollection
,SynchronizedByteIterable
,SynchronizedByteList
,SynchronizedByteSet
,SynchronizedByteStack
,SynchronizedCharByteMap
,SynchronizedDoubleByteMap
,SynchronizedFloatByteMap
,SynchronizedIntByteMap
,SynchronizedLongByteMap
,SynchronizedObjectByteMap
,SynchronizedShortByteMap
,TapByteIterable
,UnmodifiableByteBag
,UnmodifiableByteByteMap
,UnmodifiableByteCollection
,UnmodifiableByteList
,UnmodifiableByteSet
,UnmodifiableByteStack
,UnmodifiableCharByteMap
,UnmodifiableDoubleByteMap
,UnmodifiableFloatByteMap
,UnmodifiableIntByteMap
,UnmodifiableLongByteMap
,UnmodifiableObjectByteMap
,UnmodifiableShortByteMap
public interface ByteIterable extends PrimitiveIterable
ByteIterable is an interface which is memory-optimized for byte 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 ByteIterator. ByteIterator helps iterate over the ByteIterable without boxing the primitives.
This file was automatically generated from template file primitiveIterable.stg.
-
Method Summary
Modifier and Type Method Description boolean
allSatisfy(BytePredicate predicate)
Returns true if all of the elements in the ByteIterable return true for the specified predicate, otherwise returns false.boolean
anySatisfy(BytePredicate predicate)
Returns true if any of the elements in the ByteIterable return true for the specified predicate, otherwise returns false.LazyByteIterable
asLazy()
Returns a LazyByteIterable adapter wrapping the source ByteIterable.double
average()
default double
averageIfEmpty(double defaultValue)
ByteIterator
byteIterator()
Returns a primitive iterator that can be used to iterate over the ByteIterable in an imperative style.default RichIterable<ByteIterable>
chunk(int size)
Partitions elements in fixed size chunks.<V> RichIterable<V>
collect(ByteToObjectFunction<? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source collection.default <V, R extends Collection<V>>
Rcollect(ByteToObjectFunction<? extends V> function, R target)
Same ascollect(ByteToObjectFunction)
, only the results are added to the target Collection.default <R extends MutableBooleanCollection>
RcollectBoolean(ByteToBooleanFunction function, R target)
Returns the targetMutableBooleanCollection
with the results of applying the specified function on each element of the source collection.default <R extends MutableByteCollection>
RcollectByte(ByteToByteFunction function, R target)
Returns the targetMutableByteCollection
with the results of applying the specified function on each element of the source collection.default <R extends MutableCharCollection>
RcollectChar(ByteToCharFunction function, R target)
Returns the targetMutableCharCollection
with the results of applying the specified function on each element of the source collection.default <R extends MutableDoubleCollection>
RcollectDouble(ByteToDoubleFunction function, R target)
Returns the targetMutableDoubleCollection
with the results of applying the specified function on each element of the source collection.default <R extends MutableFloatCollection>
RcollectFloat(ByteToFloatFunction function, R target)
Returns the targetMutableFloatCollection
with the results of applying the specified function on each element of the source collection.default <R extends MutableIntCollection>
RcollectInt(ByteToIntFunction function, R target)
Returns the targetMutableIntCollection
with the results of applying the specified function on each element of the source collection.default <R extends MutableLongCollection>
RcollectLong(ByteToLongFunction function, R target)
Returns the targetMutableLongCollection
with the results of applying the specified function on each element of the source collection.default <R extends MutableShortCollection>
RcollectShort(ByteToShortFunction function, R target)
Returns the targetMutableShortCollection
with the results of applying the specified function on each element of the source collection.boolean
contains(byte value)
Returns true if the value is contained in the ByteIterable, and false if it is not.boolean
containsAll(byte... source)
Returns true if the all of the values specified in the source array are contained in the ByteIterable, and false if they are not.boolean
containsAll(ByteIterable source)
Returns true if the all of the values specified in the source ByteIterable are contained in the ByteIterable, and false if they are not.int
count(BytePredicate predicate)
Returns a count of the number of elements in the ByteIterable that return true for the specified predicate.byte
detectIfNone(BytePredicate predicate, byte ifNone)
void
each(ByteProcedure procedure)
A synonym for forEach.default <V, R extends Collection<V>>
RflatCollect(ByteToObjectFunction<? extends Iterable<V>> function, R target)
flatCollect
is a special case ofcollect(ByteToObjectFunction)
.void
forEach(ByteProcedure procedure)
Applies the ByteProcedure to each element in the ByteIterable.<T> T
injectInto(T injectedValue, ObjectByteToObjectFunction<? super T,? extends T> function)
byte
max()
byte
maxIfEmpty(byte defaultValue)
double
median()
default double
medianIfEmpty(double defaultValue)
byte
min()
byte
minIfEmpty(byte defaultValue)
boolean
noneSatisfy(BytePredicate predicate)
Returns true if none of the elements in the ByteIterable return true for the specified predicate, otherwise returns false.default long
reduce(LongByteToLongFunction accumulator)
default long
reduceIfEmpty(LongByteToLongFunction accumulator, long defaultValue)
ByteIterable
reject(BytePredicate predicate)
Returns a new ByteIterable with all of the elements in the ByteIterable that return false for the specified predicate.default <R extends MutableByteCollection>
Rreject(BytePredicate predicate, R target)
Same asreject(BytePredicate)
, only the results are added to the target MutableByteCollection.ByteIterable
select(BytePredicate predicate)
Returns a new ByteIterable with all of the elements in the ByteIterable that return true for the specified predicate.default <R extends MutableByteCollection>
Rselect(BytePredicate predicate, R target)
Same asselect(BytePredicate)
, only the results are added to the target MutableByteCollection.long
sum()
default IntSummaryStatistics
summaryStatistics()
default ByteIterable
tap(ByteProcedure procedure)
byte[]
toArray()
Converts the ByteIterable to a primitive byte array.default byte[]
toArray(byte[] target)
Converts the ByteIterable to a primitive byte array.MutableByteBag
toBag()
Converts the ByteIterable to a new MutableByteBag.MutableByteList
toList()
Converts the ByteIterable to a new MutableByteList.MutableByteSet
toSet()
Converts the ByteIterable to a new MutableByteSet.byte[]
toSortedArray()
MutableByteList
toSortedList()
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size, toString
-
Method Details
-
byteIterator
ByteIterator byteIterator()Returns a primitive iterator that can be used to iterate over the ByteIterable in an imperative style. -
toArray
byte[] toArray()Converts the ByteIterable to a primitive byte array. -
toArray
default byte[] toArray(byte[] target)Converts the ByteIterable to a primitive byte 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. -
contains
boolean contains(byte value)Returns true if the value is contained in the ByteIterable, and false if it is not. -
containsAll
boolean containsAll(byte... source)Returns true if the all of the values specified in the source array are contained in the ByteIterable, and false if they are not. -
containsAll
Returns true if the all of the values specified in the source ByteIterable are contained in the ByteIterable, and false if they are not. -
forEach
Applies the ByteProcedure to each element in the ByteIterable. -
each
A synonym for forEach.- Since:
- 7.0.
-
tap
- Since:
- 9.0.
-
select
Returns a new ByteIterable with all of the elements in the ByteIterable that return true for the specified predicate. -
reject
Returns a new ByteIterable with all of the elements in the ByteIterable that return false for the specified predicate. -
select
Same asselect(BytePredicate)
, only the results are added to the target MutableByteCollection.- Since:
- 8.1.
-
reject
Same asreject(BytePredicate)
, only the results are added to the target MutableByteCollection.- Since:
- 8.1.
-
collect
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. -
collect
default <V, R extends Collection<V>> R collect(ByteToObjectFunction<? extends V> function, R target)Same ascollect(ByteToObjectFunction)
, only the results are added to the target Collection.- Since:
- 8.1.
-
flatCollect
default <V, R extends Collection<V>> R flatCollect(ByteToObjectFunction<? extends Iterable<V>> function, R target)flatCollect
is a special case ofcollect(ByteToObjectFunction)
. Withcollect
, when theByteToObjectFunction
returns a collection, the result is a collection of collections.flatCollect
outputs a single "flattened" collection instead. This method is commonly called flatMap.- Since:
- 8.1.
-
collectBoolean
default <R extends MutableBooleanCollection> R collectBoolean(ByteToBooleanFunction function, R target)Returns the targetMutableBooleanCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
collectByte
Returns the targetMutableByteCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
collectChar
Returns the targetMutableCharCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
collectShort
Returns the targetMutableShortCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
collectInt
Returns the targetMutableIntCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
collectFloat
Returns the targetMutableFloatCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
collectLong
Returns the targetMutableLongCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
collectDouble
default <R extends MutableDoubleCollection> R collectDouble(ByteToDoubleFunction function, R target)Returns the targetMutableDoubleCollection
with the results of applying the specified function on each element of the source collection.- Since:
- 8.1.
-
detectIfNone
-
count
Returns a count of the number of elements in the ByteIterable that return true for the specified predicate. -
anySatisfy
Returns true if any of the elements in the ByteIterable return true for the specified predicate, otherwise returns false. -
allSatisfy
Returns true if all of the elements in the ByteIterable return true for the specified predicate, otherwise returns false. -
noneSatisfy
Returns true if none of the elements in the ByteIterable return true for the specified predicate, otherwise returns false. -
toList
MutableByteList toList()Converts the ByteIterable to a new MutableByteList. -
toSet
MutableByteSet toSet()Converts the ByteIterable to a new MutableByteSet. -
toBag
MutableByteBag toBag()Converts the ByteIterable to a new MutableByteBag. -
asLazy
LazyByteIterable asLazy()Returns a LazyByteIterable adapter wrapping the source ByteIterable. -
injectInto
-
reduceIfEmpty
- Since:
- 10.0
- See Also:
reduce(LongByteToLongFunction)
-
reduce
- Since:
- 10.0
- See Also:
RichIterable.reduce(BinaryOperator)
-
chunk
Partitions elements in fixed size chunks.- Parameters:
size
- the number of elements per chunk- Returns:
- A
RichIterable
containingByteIterable
s of sizesize
, except the last will be truncated if the elements don't divide evenly. - Since:
- 9.2
-
sum
long sum() -
summaryStatistics
- Since:
- 8.0
-
max
byte max() -
maxIfEmpty
byte maxIfEmpty(byte defaultValue) -
min
byte min() -
minIfEmpty
byte minIfEmpty(byte defaultValue) -
average
double average() -
averageIfEmpty
default double averageIfEmpty(double defaultValue)- Since:
- 9.0
-
median
double median() -
medianIfEmpty
default double medianIfEmpty(double defaultValue)- Since:
- 9.0
-
toSortedArray
byte[] toSortedArray() -
toSortedList
MutableByteList toSortedList()
-