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

Class LongInterval

java.lang.Object

org.eclipse.collections.impl.list.primitive.LongInterval

All Implemented Interfaces:

Serializable, ImmutableLongCollection, ImmutableLongList, LongList, LongIterable, OrderedLongIterable, ReversibleLongIterable, PrimitiveIterable

public final class LongInterval
extends Object
implements ImmutableLongList, Serializable

An LongInterval is a range of longs that may be iterated over using a step value. Note that the size of the interval (the number of elements in the list it represents) is limited by the maximum value of the integer index.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	allSatisfy(LongPredicate predicate)
boolean	anySatisfy(LongPredicate predicate)
void	appendString(Appendable appendable)
void	appendString(Appendable appendable, String separator)
void	appendString(Appendable appendable, String start, String separator, String end)
LazyLongIterable	asLazy()
LazyLongIterable	asReversed()
double	average()
int	binarySearch(long value)
LongInterval	by(long newStep)	This instance by method allows LongInterval to act as a fluent builder for itself.
RichIterable<LongIterable>	chunk(int size)
<V> ImmutableList<V>	collect(LongToObjectFunction<? extends V> function)
boolean	contains(long value)	Returns true if the LongInterval contains the specified long value.
boolean	containsAll(long... values)	Returns true if the LongInterval contains all the specified long values.
boolean	containsAll(LongIterable source)
boolean	containsNone(int... values)	Returns true if the LongInterval contains none of the specified long values.
int	count(LongPredicate predicate)
long	detectIfNone(LongPredicate predicate, long ifNone)
ImmutableLongList	distinct()
long	dotProduct(LongList list)
void	each(LongProcedure procedure)
boolean	equals(Object otherList)
static LongInterval	evensFromTo(long from, long to)	Returns an LongInterval representing the even values from the value from to the value to.
void	forEachWithIndex(LongIntProcedure procedure)
void	forEachWithLongIndex(LongLongProcedure procedure)	Deprecated, for removal: This API element is subject to removal in a future version.
static LongInterval	from(long newFrom)	This static from method allows LongInterval to act as a fluent builder for itself.
static LongInterval	fromTo(long from, long to)	Returns an LongInterval starting from the value from to the specified value to with a step value of 1.
static LongInterval	fromToBy(long from, long to, long stepBy)	Returns an LongInterval for the range of integers inclusively between from and to with the specified stepBy value.
long	get(int index)
long	getFirst()
long	getLast()
int	hashCode()
int	indexOf(long value)
<T> T	injectInto(T injectedValue, ObjectLongToObjectFunction<? super T,? extends T> function)
<T> T	injectIntoWithIndex(T injectedValue, ObjectLongIntToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()
int	lastIndexOf(long value)
LongIterator	longIterator()
String	makeString()
String	makeString(String separator)
String	makeString(String start, String separator, String end)
long	max()
long	maxIfEmpty(long defaultValue)
double	median()
long	min()
long	minIfEmpty(long defaultValue)
ImmutableLongList	newWith(long element)
ImmutableLongList	newWithAll(LongIterable elements)
ImmutableLongList	newWithout(long element)
ImmutableLongList	newWithoutAll(LongIterable elements)
boolean	notEmpty()
static LongInterval	oddsFromTo(long from, long to)	Returns an LongInterval representing the odd values from the value from to the value to.
static LongInterval	oneTo(long count)	Returns an LongInterval starting from 1 to the specified count value with a step value of 1.
static LongInterval	oneToBy(long count, long step)	Returns an LongInterval starting from 1 to the specified count value with a step value of step.
ImmutableLongList	reject(LongPredicate predicate)
ImmutableLongList	select(LongPredicate predicate)
int	size()	Returns the size of the interval.
Spliterator.OfLong	spliterator()
ImmutableLongList	subList(int fromIndex, int toIndex)
long	sum()
LongInterval	to(long newTo)	This instance to method allows LongInterval to act as a fluent builder for itself.
long[]	toArray()
long[]	toArray(long[] result)
MutableLongBag	toBag()
ImmutableLongList	toImmutable()
MutableLongList	toList()
LongInterval	toReversed()	Returns a new LongInterval with the from and to values reversed and the step value negated.
MutableLongSet	toSet()
long[]	toSortedArray()
MutableLongList	toSortedList()
MutableLongStack	toStack()
String	toString()
static LongInterval	zero()	Returns an LongInterval starting at zero.
static LongInterval	zeroTo(long count)	Returns an LongInterval starting from 0 to the specified count value with a step value of 1.
static LongInterval	zeroToBy(long count, long step)	Returns an LongInterval starting from 0 to the specified count value with a step value of step.
<T> ImmutableList<LongObjectPair<T>>	zip(Iterable<T> iterable)
ImmutableList<LongLongPair>	zipLong(LongIterable iterable)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.list.primitive.ImmutableLongList

collectWithIndex, rejectWithIndex, selectWithIndex, tap

Methods inherited from interface org.eclipse.collections.api.LongIterable

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, 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.LongList

forEachInBoth, primitiveParallelStream, primitiveStream

Methods inherited from interface org.eclipse.collections.api.ordered.primitive.OrderedLongIterable

collectWithIndex, rejectWithIndex, selectWithIndex

Method Detail

from

public static LongInterval from(long newFrom)

This static from method allows LongInterval to act as a fluent builder for itself. It works in conjunction with the instance methods to(long) and by(long).

Usage Example:

 LongInterval interval1 = LongInterval.from(1).to(5);         // results in: 1, 2, 3, 4, 5.
 LongInterval interval2 = LongInterval.from(1).to(10).by(2);  // results in: 1, 3, 5, 7, 9.
 

to

public LongInterval to(long newTo)

This instance to method allows LongInterval to act as a fluent builder for itself. It works in conjunction with the static method from(long) and instance method by(long).

Usage Example:

 LongInterval interval1 = LongInterval.from(1).to(5);         // results in: 1, 2, 3, 4, 5.
 LongInterval interval2 = LongInterval.from(1).to(10).by(2);  // results in: 1, 3, 5, 7, 9.
 

by

public LongInterval by(long newStep)

This instance by method allows LongInterval to act as a fluent builder for itself. It works in conjunction with the static method from(long) and instance method to(long).

Usage Example:

 LongInterval interval1 = LongInterval.from(1).to(5);         // results in: 1, 2, 3, 4, 5.
 LongInterval interval2 = LongInterval.from(1).to(10).by(2);  // results in: 1, 3, 5, 7, 9.
 

zero

public static LongInterval zero()

Returns an LongInterval starting at zero.

Usage Example:

 LongInterval interval1 = LongInterval.zero().to(5);         // results in: 0, 1, 2, 3, 4, 5.
 LongInterval interval2 = LongInterval.zero().to(10).by(2);  // results in: 0, 2, 4, 6, 8, 10.
 

oneTo

public static LongInterval oneTo(long count)

Returns an LongInterval starting from 1 to the specified count value with a step value of 1.

oneToBy

public static LongInterval oneToBy(long count,
                                   long step)

Returns an LongInterval starting from 1 to the specified count value with a step value of step.

zeroTo

public static LongInterval zeroTo(long count)

Returns an LongInterval starting from 0 to the specified count value with a step value of 1.

zeroToBy

public static LongInterval zeroToBy(long count,
                                    long step)

Returns an LongInterval starting from 0 to the specified count value with a step value of step.

fromTo

public static LongInterval fromTo(long from,
                                  long to)

Returns an LongInterval starting from the value from to the specified value to with a step value of 1.

evensFromTo

public static LongInterval evensFromTo(long from,
                                       long to)

Returns an LongInterval representing the even values from the value from to the value to.

oddsFromTo

public static LongInterval oddsFromTo(long from,
                                      long to)

Returns an LongInterval representing the odd values from the value from to the value to.

fromToBy

public static LongInterval fromToBy(long from,
                                    long to,
                                    long stepBy)

Returns an LongInterval for the range of integers inclusively between from and to with the specified stepBy value.

containsAll

public boolean containsAll(long... values)

Returns true if the LongInterval contains all the specified long values.

Specified by:

containsAll in interface LongIterable

containsAll

public boolean containsAll(LongIterable source)

Specified by:

containsAll in interface LongIterable

containsNone

public boolean containsNone(int... values)

Returns true if the LongInterval contains none of the specified long values.

contains

public boolean contains(long value)

Returns true if the LongInterval contains the specified long value.

Specified by:

contains in interface LongIterable

forEachWithIndex

public void forEachWithIndex(LongIntProcedure procedure)

Specified by:

forEachWithIndex in interface OrderedLongIterable

forEachWithLongIndex

@Deprecated(forRemoval=true)
public void forEachWithLongIndex(LongLongProcedure procedure)

Deprecated, for removal: This API element is subject to removal in a future version.

each

public void each(LongProcedure procedure)

Specified by:

each in interface LongIterable

Since:

7.0.

count

public int count(LongPredicate predicate)

Specified by:

count in interface LongIterable

anySatisfy

public boolean anySatisfy(LongPredicate predicate)

Specified by:

anySatisfy in interface LongIterable

allSatisfy

public boolean allSatisfy(LongPredicate predicate)

Specified by:

allSatisfy in interface LongIterable

equals

public boolean equals(Object otherList)

Specified by:

equals in interface LongList

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface LongList

Overrides:

hashCode in class Object

toReversed

public LongInterval toReversed()

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

Specified by:

toReversed in interface ImmutableLongList

Specified by:

toReversed in interface LongList

Specified by:

toReversed in interface ReversibleLongIterable

distinct

public ImmutableLongList distinct()

Specified by:

distinct in interface ImmutableLongList

Specified by:

distinct in interface LongList

Specified by:

distinct in interface ReversibleLongIterable

Since:

6.0

subList

public ImmutableLongList subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface ImmutableLongList

Specified by:

subList in interface LongList

size

public int size()

Returns the size of the interval.

Specified by:

size in interface PrimitiveIterable

dotProduct

public long dotProduct(LongList list)

Specified by:

dotProduct in interface LongList

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 long[] toArray()

Specified by:

toArray in interface LongIterable

toArray

public long[] toArray(long[] result)

Specified by:

toArray in interface LongIterable

injectInto

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

Specified by:

injectInto in interface LongIterable

injectIntoWithIndex

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

Specified by:

injectIntoWithIndex in interface OrderedLongIterable

Specified by:

injectIntoWithIndex in interface ReversibleLongIterable

chunk

public RichIterable<LongIterable> chunk(int size)

Specified by:

chunk in interface LongIterable

toString

public String toString()

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

longIterator

public LongIterator longIterator()

Specified by:

longIterator in interface LongIterable

getFirst

public long getFirst()

Specified by:

getFirst in interface OrderedLongIterable

getLast

public long getLast()

Specified by:

getLast in interface ReversibleLongIterable

get

public long get(int index)

Specified by:

get in interface LongList

indexOf

public int indexOf(long value)

Specified by:

indexOf in interface OrderedLongIterable

lastIndexOf

public int lastIndexOf(long value)

Specified by:

lastIndexOf in interface LongList

select

public ImmutableLongList select(LongPredicate predicate)

Specified by:

select in interface ImmutableLongCollection

Specified by:

select in interface ImmutableLongList

Specified by:

select in interface LongIterable

Specified by:

select in interface LongList

Specified by:

select in interface OrderedLongIterable

Specified by:

select in interface ReversibleLongIterable

reject

public ImmutableLongList reject(LongPredicate predicate)

Specified by:

reject in interface ImmutableLongCollection

Specified by:

reject in interface ImmutableLongList

Specified by:

reject in interface LongIterable

Specified by:

reject in interface LongList

Specified by:

reject in interface OrderedLongIterable

Specified by:

reject in interface ReversibleLongIterable

detectIfNone

public long detectIfNone(LongPredicate predicate,
                         long ifNone)

Specified by:

detectIfNone in interface LongIterable

collect

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

Specified by:

collect in interface ImmutableLongCollection

Specified by:

collect in interface ImmutableLongList

Specified by:

collect in interface LongIterable

Specified by:

collect in interface LongList

Specified by:

collect in interface OrderedLongIterable

Specified by:

collect in interface ReversibleLongIterable

asReversed

public LazyLongIterable asReversed()

Specified by:

asReversed in interface ReversibleLongIterable

sum

public long sum()

Specified by:

sum in interface LongIterable

max

public long max()

Specified by:

max in interface LongIterable

min

public long min()

Specified by:

min in interface LongIterable

minIfEmpty

public long minIfEmpty(long defaultValue)

Specified by:

minIfEmpty in interface LongIterable

maxIfEmpty

public long maxIfEmpty(long defaultValue)

Specified by:

maxIfEmpty in interface LongIterable

average

public double average()

Specified by:

average in interface LongIterable

median

public double median()

Specified by:

median in interface LongIterable

binarySearch

public int binarySearch(long value)

Specified by:

binarySearch in interface LongList

toSortedArray

public long[] toSortedArray()

Specified by:

toSortedArray in interface LongIterable

toList

public MutableLongList toList()

Specified by:

toList in interface LongIterable

toSortedList

public MutableLongList toSortedList()

Specified by:

toSortedList in interface LongIterable

toSet

public MutableLongSet toSet()

Specified by:

toSet in interface LongIterable

toBag

public MutableLongBag toBag()

Specified by:

toBag in interface LongIterable

asLazy

public LazyLongIterable asLazy()

Specified by:

asLazy in interface LongIterable

toImmutable

public ImmutableLongList toImmutable()

Specified by:

toImmutable in interface LongList

newWith

public ImmutableLongList newWith(long element)

Specified by:

newWith in interface ImmutableLongCollection

Specified by:

newWith in interface ImmutableLongList

newWithout

public ImmutableLongList newWithout(long element)

Specified by:

newWithout in interface ImmutableLongCollection

Specified by:

newWithout in interface ImmutableLongList

newWithAll

public ImmutableLongList newWithAll(LongIterable elements)

Specified by:

newWithAll in interface ImmutableLongCollection

Specified by:

newWithAll in interface ImmutableLongList

newWithoutAll

public ImmutableLongList newWithoutAll(LongIterable elements)

Specified by:

newWithoutAll in interface ImmutableLongCollection

Specified by:

newWithoutAll in interface ImmutableLongList

zipLong

public ImmutableList<LongLongPair> zipLong(LongIterable iterable)

Specified by:

zipLong in interface ImmutableLongList

Specified by:

zipLong in interface LongList

zip

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

Specified by:

zip in interface ImmutableLongList

Specified by:

zip in interface LongList

spliterator

public Spliterator.OfLong spliterator()

Specified by:

spliterator in interface LongList

toStack

public MutableLongStack toStack()

Specified by:

toStack in interface OrderedLongIterable