Package org.eclipse.collections.impl.list.primitive

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)
boolean	anySatisfy(IntPredicate predicate)
void	appendString(Appendable appendable)
void	appendString(Appendable appendable, String separator)
void	appendString(Appendable appendable, String start, String separator, String end)
LazyIntIterable	asLazy()
LazyIntIterable	asReversed()
double	average()
int	binarySearch(int value)
IntInterval	by(int newStep)	This instance by method allows IntInterval to act as a fluent builder for itself.
RichIterable<IntIterable>	chunk(int size)
<V> ImmutableList<V>	collect(IntToObjectFunction<? extends V> function)
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 the specified int values.
boolean	containsAll(IntIterable source)
boolean	containsNone(int... values)	Returns true if the IntInterval contains none of the specified int values.
int	count(IntPredicate predicate)
int	detectIfNone(IntPredicate predicate, int ifNone)
ImmutableIntList	distinct()
long	dotProduct(IntList list)
void	each(IntProcedure procedure)
boolean	equals(Object otherList)
static IntInterval	evensFromTo(int from, int to)	Returns an IntInterval representing the even values from the value from to the value to.
void	forEachWithIndex(IntIntProcedure procedure)
static IntInterval	from(int newFrom)	This static from 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()
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()
boolean	isEmpty()
int	lastIndexOf(int value)
String	makeString()
String	makeString(String separator)
String	makeString(String start, String separator, String end)
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	notEmpty()
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)
ImmutableIntList	select(IntPredicate 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 instance to method allows IntInterval to act as a fluent builder for itself.
int[]	toArray()
int[]	toArray(int[] result)
MutableIntBag	toBag()
ImmutableIntList	toImmutable()
MutableIntList	toList()
IntInterval	toReversed()	Returns a new IntInterval with the from and to values reversed and the step value negated.
MutableIntSet	toSet()
int[]	toSortedArray()
MutableIntList	toSortedList()
String	toString()
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)
ImmutableList<IntIntPair>	zipInt(IntIterable iterable)

Methods inherited from class java.lang.Object

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

Method Detail

from

public static IntInterval from(int newFrom)

This static from method allows IntInterval to act as a fluent builder for itself. It works in conjunction with the instance methods to(int) and by(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 instance to method allows IntInterval to act as a fluent builder for itself. It works in conjunction with the static method from(int) and instance method by(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 instance by method allows IntInterval to act as a fluent builder for itself. It works in conjunction with the static method from(int) and instance method to(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:

containsAll in interface IntIterable

containsAll

public boolean containsAll(IntIterable source)

Specified by:

containsAll in interface IntIterable

containsNone

public boolean containsNone(int... values)

Returns true if the IntInterval contains none of the specified int values.

Specified by:

containsNone in interface IntIterable

contains

public boolean contains(int value)

Returns true if the IntInterval contains the specified int value.

Specified by:

contains in interface IntIterable

forEachWithIndex

public void forEachWithIndex(IntIntProcedure procedure)

Specified by:

forEachWithIndex in interface OrderedIntIterable

each

public void each(IntProcedure procedure)

Specified by:

each in interface IntIterable

Since:

7.0.

count

public int count(IntPredicate predicate)

Specified by:

count in interface IntIterable

anySatisfy

public boolean anySatisfy(IntPredicate predicate)

Specified by:

anySatisfy in interface IntIterable

allSatisfy

public boolean allSatisfy(IntPredicate predicate)

Specified by:

allSatisfy in interface IntIterable

equals

public boolean equals(Object otherList)

Specified by:

equals in interface IntList

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface IntList

Overrides:

hashCode in class Object

toReversed

public IntInterval toReversed()

Returns a new IntInterval with the from and to values reversed and the step value negated.

Specified by:

toReversed in interface ImmutableIntList

Specified by:

toReversed in interface IntList

Specified by:

toReversed in interface ReversibleIntIterable

distinct

public ImmutableIntList distinct()

Specified by:

distinct in interface ImmutableIntList

Specified by:

distinct in interface IntList

Specified by:

distinct in interface ReversibleIntIterable

Since:

6.0

subList

public ImmutableIntList subList(int fromIndex,
                                int toIndex)

Specified by:

subList in interface ImmutableIntList

Specified by:

subList in interface IntList

size

public int size()

Returns the size of the interval.

Specified by:

size in interface PrimitiveIterable

dotProduct

public long dotProduct(IntList list)

Specified by:

dotProduct in interface IntList

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

makeString

public String makeString()

Specified by:

makeString in interface PrimitiveIterable

makeString

public String makeString(String separator)

Specified by:

makeString in interface PrimitiveIterable

makeString

public String makeString(String start,
                         String separator,
                         String end)

Specified by:

makeString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable)

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
                         String separator)

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
                         String start,
                         String separator,
                         String end)

Specified by:

appendString in interface PrimitiveIterable

toArray

public int[] toArray()

Specified by:

toArray in interface IntIterable

toArray

public int[] toArray(int[] result)

Specified by:

toArray in interface IntIterable

injectInto

public <T> T injectInto(T injectedValue,
                        ObjectIntToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface IntIterable

injectIntoWithIndex

public <T> T injectIntoWithIndex(T injectedValue,
                                 ObjectIntIntToObjectFunction<? super T,? extends T> function)

Specified by:

injectIntoWithIndex in interface OrderedIntIterable

Specified by:

injectIntoWithIndex in interface ReversibleIntIterable

chunk

public RichIterable<IntIterable> chunk(int size)

Specified by:

chunk in interface IntIterable

toString

public String toString()

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

intIterator

public IntIterator intIterator()

Specified by:

intIterator in interface IntIterable

getFirst

public int getFirst()

Specified by:

getFirst in interface OrderedIntIterable

getLast

public int getLast()

Specified by:

getLast in interface ReversibleIntIterable

get

public int get(int index)

Specified by:

get in interface IntList

indexOf

public int indexOf(int value)

Specified by:

indexOf in interface OrderedIntIterable

lastIndexOf

public int lastIndexOf(int value)

Specified by:

lastIndexOf in interface IntList

select

public ImmutableIntList select(IntPredicate predicate)

Specified by:

select in interface ImmutableIntCollection

Specified by:

select in interface ImmutableIntList

Specified by:

select in interface IntIterable

Specified by:

select in interface IntList

Specified by:

select in interface OrderedIntIterable

Specified by:

select in interface ReversibleIntIterable

reject

public ImmutableIntList reject(IntPredicate predicate)

Specified by:

reject in interface ImmutableIntCollection

Specified by:

reject in interface ImmutableIntList

Specified by:

reject in interface IntIterable

Specified by:

reject in interface IntList

Specified by:

reject in interface OrderedIntIterable

Specified by:

reject in interface ReversibleIntIterable

detectIfNone

public int detectIfNone(IntPredicate predicate,
                        int ifNone)

Specified by:

detectIfNone in interface IntIterable

collect

public <V> ImmutableList<V> collect(IntToObjectFunction<? extends V> function)

Specified by:

collect in interface ImmutableIntCollection

Specified by:

collect in interface ImmutableIntList

Specified by:

collect in interface IntIterable

Specified by:

collect in interface IntList

Specified by:

collect in interface OrderedIntIterable

Specified by:

collect in interface ReversibleIntIterable

asReversed

public LazyIntIterable asReversed()

Specified by:

asReversed in interface ReversibleIntIterable

sum

public long sum()

Specified by:

sum in interface IntIterable

max

public int max()

Specified by:

max in interface IntIterable

min

public int min()

Specified by:

min in interface IntIterable

minIfEmpty

public int minIfEmpty(int defaultValue)

Specified by:

minIfEmpty in interface IntIterable

maxIfEmpty

public int maxIfEmpty(int defaultValue)

Specified by:

maxIfEmpty in interface IntIterable

average

public double average()

Specified by:

average in interface IntIterable

median

public double median()

Specified by:

median in interface IntIterable

binarySearch

public int binarySearch(int value)

Specified by:

binarySearch in interface IntList

toSortedArray

public int[] toSortedArray()

Specified by:

toSortedArray in interface IntIterable

toList

public MutableIntList toList()

Specified by:

toList in interface IntIterable

toSortedList

public MutableIntList toSortedList()

Specified by:

toSortedList in interface IntIterable

toSet

public MutableIntSet toSet()

Specified by:

toSet in interface IntIterable

toBag

public MutableIntBag toBag()

Specified by:

toBag in interface IntIterable

asLazy

public LazyIntIterable asLazy()

Specified by:

asLazy in interface IntIterable

toImmutable

public ImmutableIntList toImmutable()

Specified by:

toImmutable in interface IntList

newWith

public ImmutableIntList newWith(int element)

Specified by:

newWith in interface ImmutableIntCollection

Specified by:

newWith in interface ImmutableIntList

newWithout

public ImmutableIntList newWithout(int element)

Specified by:

newWithout in interface ImmutableIntCollection

Specified by:

newWithout in interface ImmutableIntList

newWithAll

public ImmutableIntList newWithAll(IntIterable elements)

Specified by:

newWithAll in interface ImmutableIntCollection

Specified by:

newWithAll in interface ImmutableIntList

newWithoutAll

public ImmutableIntList newWithoutAll(IntIterable elements)

Specified by:

newWithoutAll in interface ImmutableIntCollection

Specified by:

newWithoutAll in interface ImmutableIntList

zipInt

public ImmutableList<IntIntPair> zipInt(IntIterable iterable)

Specified by:

zipInt in interface ImmutableIntList

Specified by:

zipInt in interface IntList

zip

public <T> ImmutableList<IntObjectPair<T>> zip(Iterable<T> iterable)

Specified by:

zip in interface ImmutableIntList

Specified by:

zip in interface IntList

spliterator

public Spliterator.OfInt spliterator()

Specified by:

spliterator in interface IntList