Class IntInterval
java.lang.Object
org.eclipse.collections.impl.list.primitive.IntInterval
- All Implemented Interfaces:
Serializable
,ImmutableIntCollection
,IntIterable
,ImmutableIntList
,IntList
,OrderedIntIterable
,ReversibleIntIterable
,PrimitiveIterable
public final class IntInterval extends Object implements ImmutableIntList, Serializable
An IntInterval is a range of ints that may be iterated over using a step value.
- See Also:
- Serialized Form
-
Method Summary
Modifier and Type Method Description boolean
allSatisfy(IntPredicate predicate)
Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.boolean
anySatisfy(IntPredicate predicate)
Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.void
appendString(Appendable appendable)
Prints a string representation of this collection onto the givenAppendable
.void
appendString(Appendable appendable, String separator)
Prints a string representation of this collection onto the givenAppendable
.void
appendString(Appendable appendable, String start, String separator, String end)
Prints a string representation of this collection onto the givenAppendable
.LazyIntIterable
asLazy()
Returns a LazyIntIterable adapter wrapping the source IntIterable.LazyIntIterable
asReversed()
double
average()
int
binarySearch(int value)
IntInterval
by(int newStep)
This instanceby
method allows IntInterval to act as a fluent builder for itself.RichIterable<IntIterable>
chunk(int size)
Partitions elements in fixed size chunks.<V> ImmutableList<V>
collect(IntToObjectFunction<? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source collection.boolean
contains(int value)
Returns true if the IntInterval contains the specified int value.boolean
containsAll(int... values)
Returns true if the IntInterval contains all of the specified int values.boolean
containsAll(IntIterable source)
Returns true if the all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.boolean
containsNone(int... values)
Returns true if the IntInterval contains none of the specified int values.int
count(IntPredicate predicate)
Returns a count of the number of elements in the IntIterable that return true for the specified predicate.int
detectIfNone(IntPredicate predicate, int ifNone)
ImmutableIntList
distinct()
long
dotProduct(IntList list)
void
each(IntProcedure procedure)
A synonym for forEach.boolean
equals(Object otherList)
Follows the same general contract asList.equals(Object)
.static IntInterval
evensFromTo(int from, int to)
Returns an IntInterval representing the even values from the value from to the value to.void
forEach(IntProcedure procedure)
Applies the IntProcedure to each element in the IntIterable.void
forEachWithIndex(IntIntProcedure procedure)
static IntInterval
from(int newFrom)
This staticfrom
method allows IntInterval to act as a fluent builder for itself.static IntInterval
fromTo(int from, int to)
Returns an IntInterval starting from the value from to the specified value to with a step value of 1.static IntInterval
fromToBy(int from, int to, int stepBy)
Returns an IntInterval for the range of integers inclusively between from and to with the specified stepBy value.int
get(int index)
int
getFirst()
int
getLast()
int
hashCode()
Follows the same general contract asList.hashCode()
.int
indexOf(int value)
<T> T
injectInto(T injectedValue, ObjectIntToObjectFunction<? super T,? extends T> function)
<T> T
injectIntoWithIndex(T injectedValue, ObjectIntIntToObjectFunction<? super T,? extends T> function)
IntIterator
intIterator()
Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.boolean
isEmpty()
Returns true if this iterable has zero items.int
lastIndexOf(int value)
String
makeString()
Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)
and defaulting the separator parameter to the characters", "
(comma and space).String
makeString(String separator)
Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String, String, String)
and defaulting the start and end parameters to""
(the empty String).String
makeString(String start, String separator, String end)
Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.int
max()
int
maxIfEmpty(int defaultValue)
double
median()
int
min()
int
minIfEmpty(int defaultValue)
ImmutableIntList
newWith(int element)
ImmutableIntList
newWithAll(IntIterable elements)
ImmutableIntList
newWithout(int element)
ImmutableIntList
newWithoutAll(IntIterable elements)
boolean
noneSatisfy(IntPredicate predicate)
Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.boolean
notEmpty()
The English equivalent of !this.isEmpty()static IntInterval
oddsFromTo(int from, int to)
Returns an IntInterval representing the odd values from the value from to the value to.static IntInterval
oneTo(int count)
Returns an IntInterval starting from 1 to the specified count value with a step value of 1.static IntInterval
oneToBy(int count, int step)
Returns an IntInterval starting from 1 to the specified count value with a step value of step.ImmutableIntList
reject(IntPredicate predicate)
Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.ImmutableIntList
select(IntPredicate predicate)
Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.int
size()
Returns the size of the interval.Spliterator.OfInt
spliterator()
ImmutableIntList
subList(int fromIndex, int toIndex)
long
sum()
IntInterval
to(int newTo)
This instanceto
method allows IntInterval to act as a fluent builder for itself.int[]
toArray()
Converts the IntIterable to a primitive int array.int[]
toArray(int[] result)
Converts the IntIterable to a primitive int array.MutableIntBag
toBag()
Converts the IntIterable to a new MutableIntBag.ImmutableIntList
toImmutable()
Returns an immutable copy of this list.MutableIntList
toList()
Converts the IntIterable to a new MutableIntList.IntInterval
toReversed()
Returns a new IntInterval with the from and to values reversed and the step value negated.MutableIntSet
toSet()
Converts the IntIterable to a new MutableIntSet.int[]
toSortedArray()
MutableIntList
toSortedList()
String
toString()
Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.static IntInterval
zero()
Returns an IntInterval starting at zero.static IntInterval
zeroTo(int count)
Returns an IntInterval starting from 0 to the specified count value with a step value of 1.static IntInterval
zeroToBy(int count, int step)
Returns an IntInterval starting from 0 to the specified count value with a step value of step.<T> ImmutableList<IntObjectPair<T>>
zip(Iterable<T> iterable)
Returns anImmutableList
formed from thisImmutableIntList
and aListIterable
by combining corresponding elements in pairs.ImmutableList<IntIntPair>
zipInt(IntIterable iterable)
Returns anImmutableList
formed from thisImmutableIntList
and anotherIntList
by combining corresponding elements in pairs.Methods inherited from interface org.eclipse.collections.api.list.primitive.ImmutableIntList
collectWithIndex, tap
Methods inherited from interface org.eclipse.collections.api.IntIterable
averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, flatCollect, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics
Methods inherited from interface org.eclipse.collections.api.list.primitive.IntList
primitiveParallelStream, primitiveStream
Methods inherited from interface org.eclipse.collections.api.ordered.primitive.OrderedIntIterable
collectWithIndex
-
Method Details
-
from
This staticfrom
method allows IntInterval to act as a fluent builder for itself. It works in conjunction with the instance methodsto(int)
andby(int)
.Usage Example:
IntInterval interval1 = IntInterval.from(1).to(5); // results in: 1, 2, 3, 4, 5. IntInterval interval2 = IntInterval.from(1).to(10).by(2); // results in: 1, 3, 5, 7, 9.
-
to
This instanceto
method allows IntInterval to act as a fluent builder for itself. It works in conjunction with the static methodfrom(int)
and instance methodby(int)
.Usage Example:
IntInterval interval1 = IntInterval.from(1).to(5); // results in: 1, 2, 3, 4, 5. IntInterval interval2 = IntInterval.from(1).to(10).by(2); // results in: 1, 3, 5, 7, 9.
-
by
This instanceby
method allows IntInterval to act as a fluent builder for itself. It works in conjunction with the static methodfrom(int)
and instance methodto(int)
.Usage Example:
IntInterval interval1 = IntInterval.from(1).to(5); // results in: 1, 2, 3, 4, 5. IntInterval interval2 = IntInterval.from(1).to(10).by(2); // results in: 1, 3, 5, 7, 9.
-
zero
Returns an IntInterval starting at zero.Usage Example:
IntInterval interval1 = IntInterval.zero().to(5); // results in: 0, 1, 2, 3, 4, 5. IntInterval interval2 = IntInterval.zero().to(10).by(2); // results in: 0, 2, 4, 6, 8, 10.
-
oneTo
Returns an IntInterval starting from 1 to the specified count value with a step value of 1. -
oneToBy
Returns an IntInterval starting from 1 to the specified count value with a step value of step. -
zeroTo
Returns an IntInterval starting from 0 to the specified count value with a step value of 1. -
zeroToBy
Returns an IntInterval starting from 0 to the specified count value with a step value of step. -
fromTo
Returns an IntInterval starting from the value from to the specified value to with a step value of 1. -
evensFromTo
Returns an IntInterval representing the even values from the value from to the value to. -
oddsFromTo
Returns an IntInterval representing the odd values from the value from to the value to. -
fromToBy
Returns an IntInterval for the range of integers inclusively between from and to with the specified stepBy value. -
containsAll
public boolean containsAll(int... values)Returns true if the IntInterval contains all of the specified int values.- Specified by:
containsAll
in interfaceIntIterable
-
containsAll
Description copied from interface:IntIterable
Returns true if the all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.- Specified by:
containsAll
in interfaceIntIterable
-
containsNone
public boolean containsNone(int... values)Returns true if the IntInterval contains none of the specified int values. -
contains
public boolean contains(int value)Returns true if the IntInterval contains the specified int value.- Specified by:
contains
in interfaceIntIterable
-
forEachWithIndex
- Specified by:
forEachWithIndex
in interfaceOrderedIntIterable
-
forEach
Description copied from interface:IntIterable
Applies the IntProcedure to each element in the IntIterable.- Specified by:
forEach
in interfaceIntIterable
-
each
Description copied from interface:IntIterable
A synonym for forEach.- Specified by:
each
in interfaceIntIterable
- Since:
- 7.0.
-
count
Description copied from interface:IntIterable
Returns a count of the number of elements in the IntIterable that return true for the specified predicate.- Specified by:
count
in interfaceIntIterable
-
anySatisfy
Description copied from interface:IntIterable
Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.- Specified by:
anySatisfy
in interfaceIntIterable
-
allSatisfy
Description copied from interface:IntIterable
Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.- Specified by:
allSatisfy
in interfaceIntIterable
-
noneSatisfy
Description copied from interface:IntIterable
Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.- Specified by:
noneSatisfy
in interfaceIntIterable
-
equals
Description copied from interface:IntList
Follows the same general contract asList.equals(Object)
. -
hashCode
public int hashCode()Description copied from interface:IntList
Follows the same general contract asList.hashCode()
. -
toReversed
Returns a new IntInterval with the from and to values reversed and the step value negated.- Specified by:
toReversed
in interfaceImmutableIntList
- Specified by:
toReversed
in interfaceIntList
- Specified by:
toReversed
in interfaceReversibleIntIterable
-
distinct
- Specified by:
distinct
in interfaceImmutableIntList
- Specified by:
distinct
in interfaceIntList
- Specified by:
distinct
in interfaceReversibleIntIterable
- Since:
- 6.0
-
subList
- Specified by:
subList
in interfaceImmutableIntList
- Specified by:
subList
in interfaceIntList
- See Also:
List.subList(int fromIndex, int toIndex)
-
size
public int size()Returns the size of the interval.- Specified by:
size
in interfacePrimitiveIterable
-
dotProduct
- Specified by:
dotProduct
in interfaceIntList
-
isEmpty
public boolean isEmpty()Description copied from interface:PrimitiveIterable
Returns true if this iterable has zero items.- Specified by:
isEmpty
in interfacePrimitiveIterable
-
notEmpty
public boolean notEmpty()Description copied from interface:PrimitiveIterable
The English equivalent of !this.isEmpty()- Specified by:
notEmpty
in interfacePrimitiveIterable
-
makeString
Description copied from interface:PrimitiveIterable
Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)
and defaulting the separator parameter to the characters", "
(comma and space).- Specified by:
makeString
in interfacePrimitiveIterable
- Returns:
- a string representation of this collection.
-
makeString
Description copied from interface:PrimitiveIterable
Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String, String, String)
and defaulting the start and end parameters to""
(the empty String).- Specified by:
makeString
in interfacePrimitiveIterable
- Returns:
- a string representation of this collection.
-
makeString
Description copied from interface:PrimitiveIterable
Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.- Specified by:
makeString
in interfacePrimitiveIterable
- Returns:
- a string representation of this collection.
-
appendString
Description copied from interface:PrimitiveIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byPrimitiveIterable.makeString()
.- Specified by:
appendString
in interfacePrimitiveIterable
-
appendString
Description copied from interface:PrimitiveIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byPrimitiveIterable.makeString(String)
.- Specified by:
appendString
in interfacePrimitiveIterable
-
appendString
Description copied from interface:PrimitiveIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byPrimitiveIterable.makeString(String, String, String)
.- Specified by:
appendString
in interfacePrimitiveIterable
-
toArray
public int[] toArray()Description copied from interface:IntIterable
Converts the IntIterable to a primitive int array.- Specified by:
toArray
in interfaceIntIterable
-
toArray
public int[] toArray(int[] result)Description copied from interface:IntIterable
Converts the IntIterable to a primitive int 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.- Specified by:
toArray
in interfaceIntIterable
-
injectInto
public <T> T injectInto(T injectedValue, ObjectIntToObjectFunction<? super T,? extends T> function)- Specified by:
injectInto
in interfaceIntIterable
-
injectIntoWithIndex
public <T> T injectIntoWithIndex(T injectedValue, ObjectIntIntToObjectFunction<? super T,? extends T> function)- Specified by:
injectIntoWithIndex
in interfaceOrderedIntIterable
- Specified by:
injectIntoWithIndex
in interfaceReversibleIntIterable
-
chunk
Description copied from interface:IntIterable
Partitions elements in fixed size chunks.- Specified by:
chunk
in interfaceIntIterable
- Parameters:
size
- the number of elements per chunk- Returns:
- A
RichIterable
containingIntIterable
s of sizesize
, except the last will be truncated if the elements don't divide evenly.
-
toString
Description copied from interface:PrimitiveIterable
Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.Assert.assertEquals("[]", IntLists.mutable.empty().toString()); Assert.assertEquals("[1]", IntLists.mutable.with(1).toString()); Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classObject
- Returns:
- a string representation of this PrimitiveIterable
- See Also:
AbstractCollection.toString()
-
intIterator
Description copied from interface:IntIterable
Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.- Specified by:
intIterator
in interfaceIntIterable
-
getFirst
public int getFirst()- Specified by:
getFirst
in interfaceOrderedIntIterable
-
getLast
public int getLast()- Specified by:
getLast
in interfaceReversibleIntIterable
-
get
public int get(int index) -
indexOf
public int indexOf(int value)- Specified by:
indexOf
in interfaceOrderedIntIterable
-
lastIndexOf
public int lastIndexOf(int value)- Specified by:
lastIndexOf
in interfaceIntList
-
select
Description copied from interface:IntIterable
Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.- Specified by:
select
in interfaceImmutableIntCollection
- Specified by:
select
in interfaceImmutableIntList
- Specified by:
select
in interfaceIntIterable
- Specified by:
select
in interfaceIntList
- Specified by:
select
in interfaceOrderedIntIterable
- Specified by:
select
in interfaceReversibleIntIterable
-
reject
Description copied from interface:IntIterable
Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.- Specified by:
reject
in interfaceImmutableIntCollection
- Specified by:
reject
in interfaceImmutableIntList
- Specified by:
reject
in interfaceIntIterable
- Specified by:
reject
in interfaceIntList
- Specified by:
reject
in interfaceOrderedIntIterable
- Specified by:
reject
in interfaceReversibleIntIterable
-
detectIfNone
- Specified by:
detectIfNone
in interfaceIntIterable
-
collect
Description copied from interface:IntIterable
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.- Specified by:
collect
in interfaceImmutableIntCollection
- Specified by:
collect
in interfaceImmutableIntList
- Specified by:
collect
in interfaceIntIterable
- Specified by:
collect
in interfaceIntList
- Specified by:
collect
in interfaceOrderedIntIterable
- Specified by:
collect
in interfaceReversibleIntIterable
-
asReversed
- Specified by:
asReversed
in interfaceReversibleIntIterable
-
sum
public long sum()- Specified by:
sum
in interfaceIntIterable
-
max
public int max()- Specified by:
max
in interfaceIntIterable
-
min
public int min()- Specified by:
min
in interfaceIntIterable
-
minIfEmpty
public int minIfEmpty(int defaultValue)- Specified by:
minIfEmpty
in interfaceIntIterable
-
maxIfEmpty
public int maxIfEmpty(int defaultValue)- Specified by:
maxIfEmpty
in interfaceIntIterable
-
average
public double average()- Specified by:
average
in interfaceIntIterable
-
median
public double median()- Specified by:
median
in interfaceIntIterable
-
binarySearch
public int binarySearch(int value)- Specified by:
binarySearch
in interfaceIntList
-
toSortedArray
public int[] toSortedArray()- Specified by:
toSortedArray
in interfaceIntIterable
-
toList
Description copied from interface:IntIterable
Converts the IntIterable to a new MutableIntList.- Specified by:
toList
in interfaceIntIterable
-
toSortedList
- Specified by:
toSortedList
in interfaceIntIterable
-
toSet
Description copied from interface:IntIterable
Converts the IntIterable to a new MutableIntSet.- Specified by:
toSet
in interfaceIntIterable
-
toBag
Description copied from interface:IntIterable
Converts the IntIterable to a new MutableIntBag.- Specified by:
toBag
in interfaceIntIterable
-
asLazy
Description copied from interface:IntIterable
Returns a LazyIntIterable adapter wrapping the source IntIterable.- Specified by:
asLazy
in interfaceIntIterable
-
toImmutable
Description copied from interface:IntList
Returns an immutable copy of this list. If the list is immutable, it returns itself.- Specified by:
toImmutable
in interfaceIntList
-
newWith
- Specified by:
newWith
in interfaceImmutableIntCollection
- Specified by:
newWith
in interfaceImmutableIntList
-
newWithout
- Specified by:
newWithout
in interfaceImmutableIntCollection
- Specified by:
newWithout
in interfaceImmutableIntList
-
newWithAll
- Specified by:
newWithAll
in interfaceImmutableIntCollection
- Specified by:
newWithAll
in interfaceImmutableIntList
-
newWithoutAll
- Specified by:
newWithoutAll
in interfaceImmutableIntCollection
- Specified by:
newWithoutAll
in interfaceImmutableIntList
-
zipInt
Description copied from interface:ImmutableIntList
Returns anImmutableList
formed from thisImmutableIntList
and anotherIntList
by combining corresponding elements in pairs. If one of the twoIntList
s is longer than the other, its remaining elements are ignored.- Specified by:
zipInt
in interfaceImmutableIntList
- Specified by:
zipInt
in interfaceIntList
-
zip
Description copied from interface:ImmutableIntList
Returns anImmutableList
formed from thisImmutableIntList
and aListIterable
by combining corresponding elements in pairs. If one of the two Lists is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceImmutableIntList
- Specified by:
zip
in interfaceIntList
-
spliterator
- Specified by:
spliterator
in interfaceIntList
-