Class IntInterval
- java.lang.Object
-
- org.eclipse.collections.impl.list.primitive.IntInterval
-
- All Implemented Interfaces:
java.io.Serializable,ImmutableIntCollection,IntIterable,ImmutableIntList,IntList,OrderedIntIterable,ReversibleIntIterable,PrimitiveIterable
public final class IntInterval extends java.lang.Object implements ImmutableIntList, java.io.Serializable
An IntInterval is a range of ints that may be iterated over using a step value.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private classIntInterval.IntIntervalIteratorprivate static classIntInterval.IntIntervalSpliterator
-
Field Summary
Fields Modifier and Type Field Description private intfromprivate static longserialVersionUIDprivate intsizeprivate intstepprivate intto
-
Constructor Summary
Constructors Modifier Constructor Description privateIntInterval(int from, int to, int step)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallSatisfy(IntPredicate predicate)Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.booleananySatisfy(IntPredicate predicate)Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.voidappendString(java.lang.Appendable appendable)Prints a string representation of this collection onto the givenAppendable.voidappendString(java.lang.Appendable appendable, java.lang.String separator)Prints a string representation of this collection onto the givenAppendable.voidappendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)Prints a string representation of this collection onto the givenAppendable.LazyIntIterableasLazy()Returns a LazyIntIterable adapter wrapping the source IntIterable.LazyIntIterableasReversed()doubleaverage()intbinarySearch(int value)IntIntervalby(int newStep)This instancebymethod allows IntInterval to act as a fluent builder for itself.private voidcheckBounds(java.lang.String name, int index)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.booleancontains(int value)Returns true if the IntInterval contains the specified int value.booleancontainsAll(int... values)Returns true if the IntInterval contains all the specified int values.booleancontainsAll(IntIterable source)Returns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.booleancontainsNone(int... values)Returns true if the IntInterval contains none of the specified int values.intcount(IntPredicate predicate)Returns a count of the number of elements in the IntIterable that return true for the specified predicate.intdetectIfNone(IntPredicate predicate, int ifNone)ImmutableIntListdistinct()longdotProduct(IntList list)voideach(IntProcedure procedure)A synonym for forEach.booleanequals(java.lang.Object otherList)Follows the same general contract asList.equals(Object).static IntIntervalevensFromTo(int from, int to)Returns an IntInterval representing the even values from the value from to the value to.voidforEachWithIndex(IntIntProcedure procedure)static IntIntervalfrom(int newFrom)This staticfrommethod allows IntInterval to act as a fluent builder for itself.static IntIntervalfromTo(int from, int to)Returns an IntInterval starting from the value from to the specified value to with a step value of 1.static IntIntervalfromToBy(int from, int to, int stepBy)Returns an IntInterval for the range of integers inclusively between from and to with the specified stepBy value.intget(int index)intgetFirst()intgetLast()private booleangoForward()inthashCode()Follows the same general contract asList.hashCode().intindexOf(int value)<T> TinjectInto(T injectedValue, ObjectIntToObjectFunction<? super T,? extends T> function)<T> TinjectIntoWithIndex(T injectedValue, ObjectIntIntToObjectFunction<? super T,? extends T> function)IntIteratorintIterator()Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.booleanisEmpty()Returns true if this iterable has zero items.intlastIndexOf(int value)java.lang.StringmakeString()Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)and defaulting the separator parameter to the characters", "(comma and space).java.lang.StringmakeString(java.lang.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).java.lang.StringmakeString(java.lang.String start, java.lang.String separator, java.lang.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.intmax()intmaxIfEmpty(int defaultValue)doublemedian()intmin()intminIfEmpty(int defaultValue)ImmutableIntListnewWith(int element)ImmutableIntListnewWithAll(IntIterable elements)ImmutableIntListnewWithout(int element)ImmutableIntListnewWithoutAll(IntIterable elements)booleannotEmpty()The English equivalent of !this.isEmpty()static IntIntervaloddsFromTo(int from, int to)Returns an IntInterval representing the odd values from the value from to the value to.static IntIntervaloneTo(int count)Returns an IntInterval starting from 1 to the specified count value with a step value of 1.static IntIntervaloneToBy(int count, int step)Returns an IntInterval starting from 1 to the specified count value with a step value of step.private voidreadObject(java.io.ObjectInputStream ois)ImmutableIntListreject(IntPredicate predicate)Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.ImmutableIntListselect(IntPredicate predicate)Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.intsize()Returns the size of the interval.java.util.Spliterator.OfIntspliterator()ImmutableIntListsubList(int fromIndex, int toIndex)longsum()IntIntervalto(int newTo)This instancetomethod 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.MutableIntBagtoBag()Converts the IntIterable to a new MutableIntBag.ImmutableIntListtoImmutable()Returns an immutable copy of this list.MutableIntListtoList()Converts the IntIterable to a new MutableIntList.IntIntervaltoReversed()Returns a new IntInterval with the from and to values reversed and the step value negated.MutableIntSettoSet()Converts the IntIterable to a new MutableIntSet.int[]toSortedArray()MutableIntListtoSortedList()MutableIntStacktoStack()Converts the collection to a IntStack.java.lang.StringtoString()Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.static IntIntervalzero()Returns an IntInterval starting at zero.static IntIntervalzeroTo(int count)Returns an IntInterval starting from 0 to the specified count value with a step value of 1.static IntIntervalzeroToBy(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(java.lang.Iterable<T> iterable)Returns anImmutableListformed from thisImmutableIntListand aListIterableby combining corresponding elements in pairs.ImmutableList<IntIntPair>zipInt(IntIterable iterable)Returns anImmutableListformed from thisImmutableIntListand anotherIntListby combining corresponding elements in pairs.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.collections.api.list.primitive.ImmutableIntList
collectWithIndex, rejectWithIndex, selectWithIndex, tap
-
Methods inherited from interface org.eclipse.collections.api.IntIterable
averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, medianIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy
-
Methods inherited from interface org.eclipse.collections.api.list.primitive.IntList
forEachInBoth, primitiveParallelStream, primitiveStream
-
Methods inherited from interface org.eclipse.collections.api.ordered.primitive.OrderedIntIterable
collectWithIndex, rejectWithIndex, selectWithIndex
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
from
private final int from
-
to
private final int to
-
step
private final int step
-
size
private transient int size
-
-
Method Detail
-
from
public static IntInterval from(int newFrom)
This staticfrommethod 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
public IntInterval to(int newTo)
This instancetomethod 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
public IntInterval by(int newStep)
This instancebymethod 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
public static IntInterval 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
public static IntInterval oneTo(int count)
Returns an IntInterval starting from 1 to the specified count value with a step value of 1.
-
oneToBy
public static IntInterval oneToBy(int count, int step)
Returns an IntInterval starting from 1 to the specified count value with a step value of step.
-
zeroTo
public static IntInterval zeroTo(int count)
Returns an IntInterval starting from 0 to the specified count value with a step value of 1.
-
zeroToBy
public static IntInterval zeroToBy(int count, int step)
Returns an IntInterval starting from 0 to the specified count value with a step value of step.
-
fromTo
public 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.
-
evensFromTo
public static IntInterval evensFromTo(int from, int to)
Returns an IntInterval representing the even values from the value from to the value to.
-
oddsFromTo
public static IntInterval oddsFromTo(int from, int to)
Returns an IntInterval representing the odd values from the value from to the value to.
-
fromToBy
public 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.
-
containsAll
public boolean containsAll(int... values)
Returns true if the IntInterval contains all the specified int values.- Specified by:
containsAllin interfaceIntIterable
-
containsAll
public boolean containsAll(IntIterable source)
Description copied from interface:IntIterableReturns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.- Specified by:
containsAllin interfaceIntIterable
-
containsNone
public boolean containsNone(int... values)
Returns true if the IntInterval contains none of the specified int values.- Specified by:
containsNonein interfaceIntIterable
-
contains
public boolean contains(int value)
Returns true if the IntInterval contains the specified int value.- Specified by:
containsin interfaceIntIterable
-
forEachWithIndex
public void forEachWithIndex(IntIntProcedure procedure)
- Specified by:
forEachWithIndexin interfaceOrderedIntIterable
-
goForward
private boolean goForward()
-
each
public void each(IntProcedure procedure)
Description copied from interface:IntIterableA synonym for forEach.- Specified by:
eachin interfaceIntIterable- Since:
- 7.0.
-
count
public int count(IntPredicate predicate)
Description copied from interface:IntIterableReturns a count of the number of elements in the IntIterable that return true for the specified predicate.- Specified by:
countin interfaceIntIterable
-
anySatisfy
public boolean anySatisfy(IntPredicate predicate)
Description copied from interface:IntIterableReturns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.- Specified by:
anySatisfyin interfaceIntIterable
-
allSatisfy
public boolean allSatisfy(IntPredicate predicate)
Description copied from interface:IntIterableReturns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.- Specified by:
allSatisfyin interfaceIntIterable
-
equals
public boolean equals(java.lang.Object otherList)
Description copied from interface:IntListFollows the same general contract asList.equals(Object).
-
hashCode
public int hashCode()
Description copied from interface:IntListFollows the same general contract asList.hashCode().
-
toReversed
public IntInterval toReversed()
Returns a new IntInterval with the from and to values reversed and the step value negated.- Specified by:
toReversedin interfaceImmutableIntList- Specified by:
toReversedin interfaceIntList- Specified by:
toReversedin interfaceReversibleIntIterable
-
distinct
public ImmutableIntList distinct()
- Specified by:
distinctin interfaceImmutableIntList- Specified by:
distinctin interfaceIntList- Specified by:
distinctin interfaceReversibleIntIterable- Since:
- 6.0
-
subList
public ImmutableIntList subList(int fromIndex, int toIndex)
- Specified by:
subListin interfaceImmutableIntList- Specified by:
subListin interfaceIntList- See Also:
List.subList(int fromIndex, int toIndex)
-
size
public int size()
Returns the size of the interval.- Specified by:
sizein interfacePrimitiveIterable
-
dotProduct
public long dotProduct(IntList list)
- Specified by:
dotProductin interfaceIntList
-
isEmpty
public boolean isEmpty()
Description copied from interface:PrimitiveIterableReturns true if this iterable has zero items.- Specified by:
isEmptyin interfacePrimitiveIterable
-
notEmpty
public boolean notEmpty()
Description copied from interface:PrimitiveIterableThe English equivalent of !this.isEmpty()- Specified by:
notEmptyin interfacePrimitiveIterable
-
makeString
public java.lang.String makeString()
Description copied from interface:PrimitiveIterableReturns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)and defaulting the separator parameter to the characters", "(comma and space).- Specified by:
makeStringin interfacePrimitiveIterable- Returns:
- a string representation of this collection.
-
makeString
public java.lang.String makeString(java.lang.String separator)
Description copied from interface:PrimitiveIterableReturns 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:
makeStringin interfacePrimitiveIterable- Returns:
- a string representation of this collection.
-
makeString
public java.lang.String makeString(java.lang.String start, java.lang.String separator, java.lang.String end)Description copied from interface:PrimitiveIterableReturns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.- Specified by:
makeStringin interfacePrimitiveIterable- Returns:
- a string representation of this collection.
-
appendString
public void appendString(java.lang.Appendable appendable)
Description copied from interface:PrimitiveIterablePrints a string representation of this collection onto the givenAppendable. Prints the string returned byPrimitiveIterable.makeString().- Specified by:
appendStringin interfacePrimitiveIterable
-
appendString
public void appendString(java.lang.Appendable appendable, java.lang.String separator)Description copied from interface:PrimitiveIterablePrints a string representation of this collection onto the givenAppendable. Prints the string returned byPrimitiveIterable.makeString(String).- Specified by:
appendStringin interfacePrimitiveIterable
-
appendString
public void appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)Description copied from interface:PrimitiveIterablePrints a string representation of this collection onto the givenAppendable. Prints the string returned byPrimitiveIterable.makeString(String, String, String).- Specified by:
appendStringin interfacePrimitiveIterable
-
toArray
public int[] toArray()
Description copied from interface:IntIterableConverts the IntIterable to a primitive int array.- Specified by:
toArrayin interfaceIntIterable
-
toArray
public int[] toArray(int[] result)
Description copied from interface:IntIterableConverts 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:
toArrayin interfaceIntIterable
-
injectInto
public <T> T injectInto(T injectedValue, ObjectIntToObjectFunction<? super T,? extends T> function)- Specified by:
injectIntoin interfaceIntIterable
-
injectIntoWithIndex
public <T> T injectIntoWithIndex(T injectedValue, ObjectIntIntToObjectFunction<? super T,? extends T> function)- Specified by:
injectIntoWithIndexin interfaceOrderedIntIterable- Specified by:
injectIntoWithIndexin interfaceReversibleIntIterable
-
chunk
public RichIterable<IntIterable> chunk(int size)
Description copied from interface:IntIterablePartitions elements in fixed size chunks.- Specified by:
chunkin interfaceIntIterable- Parameters:
size- the number of elements per chunk- Returns:
- A
RichIterablecontainingIntIterables of sizesize, except the last will be truncated if the elements don't divide evenly.
-
toString
public java.lang.String toString()
Description copied from interface:PrimitiveIterableReturns 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:
toStringin interfacePrimitiveIterable- Overrides:
toStringin classjava.lang.Object- Returns:
- a string representation of this PrimitiveIterable
- See Also:
AbstractCollection.toString()
-
intIterator
public IntIterator intIterator()
Description copied from interface:IntIterableReturns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.- Specified by:
intIteratorin interfaceIntIterable
-
getFirst
public int getFirst()
- Specified by:
getFirstin interfaceOrderedIntIterable
-
getLast
public int getLast()
- Specified by:
getLastin interfaceReversibleIntIterable
-
checkBounds
private void checkBounds(java.lang.String name, int index)
-
indexOf
public int indexOf(int value)
- Specified by:
indexOfin interfaceOrderedIntIterable
-
lastIndexOf
public int lastIndexOf(int value)
- Specified by:
lastIndexOfin interfaceIntList
-
select
public ImmutableIntList select(IntPredicate predicate)
Description copied from interface:IntIterableReturns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.- Specified by:
selectin interfaceImmutableIntCollection- Specified by:
selectin interfaceImmutableIntList- Specified by:
selectin interfaceIntIterable- Specified by:
selectin interfaceIntList- Specified by:
selectin interfaceOrderedIntIterable- Specified by:
selectin interfaceReversibleIntIterable
-
reject
public ImmutableIntList reject(IntPredicate predicate)
Description copied from interface:IntIterableReturns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.- Specified by:
rejectin interfaceImmutableIntCollection- Specified by:
rejectin interfaceImmutableIntList- Specified by:
rejectin interfaceIntIterable- Specified by:
rejectin interfaceIntList- Specified by:
rejectin interfaceOrderedIntIterable- Specified by:
rejectin interfaceReversibleIntIterable
-
detectIfNone
public int detectIfNone(IntPredicate predicate, int ifNone)
- Specified by:
detectIfNonein interfaceIntIterable
-
collect
public <V> ImmutableList<V> collect(IntToObjectFunction<? extends V> function)
Description copied from interface:IntIterableReturns 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:
collectin interfaceImmutableIntCollection- Specified by:
collectin interfaceImmutableIntList- Specified by:
collectin interfaceIntIterable- Specified by:
collectin interfaceIntList- Specified by:
collectin interfaceOrderedIntIterable- Specified by:
collectin interfaceReversibleIntIterable
-
asReversed
public LazyIntIterable asReversed()
- Specified by:
asReversedin interfaceReversibleIntIterable
-
sum
public long sum()
- Specified by:
sumin interfaceIntIterable
-
max
public int max()
- Specified by:
maxin interfaceIntIterable
-
min
public int min()
- Specified by:
minin interfaceIntIterable
-
minIfEmpty
public int minIfEmpty(int defaultValue)
- Specified by:
minIfEmptyin interfaceIntIterable
-
maxIfEmpty
public int maxIfEmpty(int defaultValue)
- Specified by:
maxIfEmptyin interfaceIntIterable
-
average
public double average()
- Specified by:
averagein interfaceIntIterable
-
median
public double median()
- Specified by:
medianin interfaceIntIterable
-
binarySearch
public int binarySearch(int value)
- Specified by:
binarySearchin interfaceIntList
-
toSortedArray
public int[] toSortedArray()
- Specified by:
toSortedArrayin interfaceIntIterable
-
toList
public MutableIntList toList()
Description copied from interface:IntIterableConverts the IntIterable to a new MutableIntList.- Specified by:
toListin interfaceIntIterable
-
toSortedList
public MutableIntList toSortedList()
- Specified by:
toSortedListin interfaceIntIterable
-
toSet
public MutableIntSet toSet()
Description copied from interface:IntIterableConverts the IntIterable to a new MutableIntSet.- Specified by:
toSetin interfaceIntIterable
-
toBag
public MutableIntBag toBag()
Description copied from interface:IntIterableConverts the IntIterable to a new MutableIntBag.- Specified by:
toBagin interfaceIntIterable
-
asLazy
public LazyIntIterable asLazy()
Description copied from interface:IntIterableReturns a LazyIntIterable adapter wrapping the source IntIterable.- Specified by:
asLazyin interfaceIntIterable
-
toImmutable
public ImmutableIntList toImmutable()
Description copied from interface:IntListReturns an immutable copy of this list. If the list is immutable, it returns itself.- Specified by:
toImmutablein interfaceIntList
-
newWith
public ImmutableIntList newWith(int element)
- Specified by:
newWithin interfaceImmutableIntCollection- Specified by:
newWithin interfaceImmutableIntList
-
newWithout
public ImmutableIntList newWithout(int element)
- Specified by:
newWithoutin interfaceImmutableIntCollection- Specified by:
newWithoutin interfaceImmutableIntList
-
newWithAll
public ImmutableIntList newWithAll(IntIterable elements)
- Specified by:
newWithAllin interfaceImmutableIntCollection- Specified by:
newWithAllin interfaceImmutableIntList
-
newWithoutAll
public ImmutableIntList newWithoutAll(IntIterable elements)
- Specified by:
newWithoutAllin interfaceImmutableIntCollection- Specified by:
newWithoutAllin interfaceImmutableIntList
-
zipInt
public ImmutableList<IntIntPair> zipInt(IntIterable iterable)
Description copied from interface:ImmutableIntListReturns anImmutableListformed from thisImmutableIntListand anotherIntListby combining corresponding elements in pairs. If one of the twoIntLists is longer than the other, its remaining elements are ignored.- Specified by:
zipIntin interfaceImmutableIntList- Specified by:
zipIntin interfaceIntList
-
zip
public <T> ImmutableList<IntObjectPair<T>> zip(java.lang.Iterable<T> iterable)
Description copied from interface:ImmutableIntListReturns anImmutableListformed from thisImmutableIntListand aListIterableby combining corresponding elements in pairs. If one of the two Lists is longer than the other, its remaining elements are ignored.- Specified by:
zipin interfaceImmutableIntList- Specified by:
zipin interfaceIntList
-
spliterator
public java.util.Spliterator.OfInt spliterator()
- Specified by:
spliteratorin interfaceIntList
-
toStack
public MutableIntStack toStack()
Description copied from interface:OrderedIntIterableConverts the collection to a IntStack.- Specified by:
toStackin interfaceOrderedIntIterable
-
readObject
private void readObject(java.io.ObjectInputStream ois) throws java.io.IOException, java.lang.ClassNotFoundException- Throws:
java.io.IOExceptionjava.lang.ClassNotFoundException
-
-