Package org.eclipse.collections.impl.stack.mutable.primitive

Class UnmodifiableIntStack

java.lang.Object

org.eclipse.collections.impl.stack.mutable.primitive.UnmodifiableIntStack

All Implemented Interfaces:

Serializable, IntIterable, OrderedIntIterable, PrimitiveIterable, IntStack, MutableIntStack

public class UnmodifiableIntStack
extends Object
implements MutableIntStack, Serializable

This file was automatically generated from template file unmodifiablePrimitiveStack.stg.

Since:

3.1.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableIntStack(MutableIntStack stack)

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 given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyIntIterable	asLazy()	Returns a LazyIntIterable adapter wrapping the source IntIterable.
MutableIntStack	asSynchronized()
MutableIntStack	asUnmodifiable()
double	average()
RichIterable<IntIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()	Clears the Stack
<V> MutableStack<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.
<V> MutableStack<V>	collectWithIndex(IntIntToObjectFunction<? extends V> function)	Returns a new MutableStack using results obtained by applying the specified function to each element and its corresponding index.
<V, R extends Collection<V>> R	collectWithIndex(IntIntToObjectFunction<? extends V> function, R target)	Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.
boolean	contains(int value)	Returns true if the value is contained in the IntIterable, and false if it is not.
boolean	containsAll(int... source)	Returns true if all of the values specified in the source array are contained in the IntIterable, and false if they are not.
boolean	containsAll(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.
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)
void	each(IntProcedure procedure)	A synonym for forEach.
boolean	equals(Object otherStack)	Follows the same general contract as StackIterable.equals(Object).
void	forEach(IntProcedure procedure)	Applies the IntProcedure to each element in the IntIterable.
void	forEachWithIndex(IntIntProcedure procedure)
int	getFirst()
int	hashCode()	Follows the same general contract as StackIterable.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.
String	makeString()	Returns a string representation of this collection by delegating to PrimitiveIterable.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 to PrimitiveIterable.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)
MutableIntStack	newEmpty()	Creates a new empty mutable version of the same stack type.
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()
int	peek()	Returns the top of the stack.
IntList	peek(int count)	Returns IntList of the number of elements specified by the count, beginning with the top of the stack.
int	peekAt(int index)	Returns the element at the specified index.
int	pop()	Removes and returns the top element of the stack.
IntList	pop(int count)	Removes and returns a IntList of the number of elements specified by the count, beginning with the top of the stack.
void	push(int item)	Adds an item to the top of the stack.
MutableIntStack	reject(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
MutableIntStack	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 number of items in this iterable.
long	sum()
int[]	toArray()	Converts the IntIterable to a primitive int array.
int[]	toArray(int[] target)	Converts the IntIterable to a primitive int array.
MutableIntBag	toBag()	Converts the IntIterable to a new MutableIntBag.
ImmutableIntStack	toImmutable()
MutableIntList	toList()	Converts the IntIterable to a new MutableIntList.
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, containsNone, flatCollect, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface org.eclipse.collections.api.stack.primitive.MutableIntStack

tap

Constructor Details

UnmodifiableIntStack

public UnmodifiableIntStack(MutableIntStack stack)

Method Details

push

public void push(int item)

Description copied from interface: MutableIntStack

Adds an item to the top of the stack.

Specified by:

push in interface MutableIntStack

pop

public int pop()

Description copied from interface: MutableIntStack

Removes and returns the top element of the stack.

Specified by:

pop in interface MutableIntStack

pop

public IntList pop(int count)

Description copied from interface: MutableIntStack

Removes and returns a IntList of the number of elements specified by the count, beginning with the top of the stack.

Specified by:

pop in interface MutableIntStack

peek

public int peek()

Description copied from interface: IntStack

Returns the top of the stack.

Specified by:

peek in interface IntStack

peek

public IntList peek(int count)

Description copied from interface: IntStack

Returns IntList of the number of elements specified by the count, beginning with the top of the stack.

Specified by:

peek in interface IntStack

peekAt

public int peekAt(int index)

Description copied from interface: IntStack

Returns the element at the specified index.

Specified by:

peekAt in interface IntStack

Parameters:

index - the location to peek into

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

clear

public void clear()

Description copied from interface: MutableIntStack

Clears the Stack

Specified by:

clear in interface MutableIntStack

contains

public boolean contains(int value)

Description copied from interface: IntIterable

Returns true if the value is contained in the IntIterable, and false if it is not.

Specified by:

contains in interface IntIterable

containsAll

public boolean containsAll(int... source)

Description copied from interface: IntIterable

Returns true if all of the values specified in the source array are contained in the IntIterable, and false if they are not.

Specified by:

containsAll in interface IntIterable

containsAll

public boolean containsAll(IntIterable source)

Description copied from interface: IntIterable

Returns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.

Specified by:

containsAll in interface IntIterable

intIterator

public IntIterator 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 interface IntIterable

forEach

public void forEach(IntProcedure procedure)

Description copied from interface: IntIterable

Applies the IntProcedure to each element in the IntIterable.

Specified by:

forEach in interface IntIterable

each

public void each(IntProcedure procedure)

Description copied from interface: IntIterable

A synonym for forEach.

Specified by:

each in interface IntIterable

Since:

7.0.

count

public int count(IntPredicate predicate)

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 interface IntIterable

anySatisfy

public boolean anySatisfy(IntPredicate predicate)

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 interface IntIterable

allSatisfy

public boolean allSatisfy(IntPredicate predicate)

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 interface IntIterable

noneSatisfy

public boolean noneSatisfy(IntPredicate predicate)

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 interface IntIterable

detectIfNone

public int detectIfNone(IntPredicate predicate,
 int ifNone)

Specified by:

detectIfNone in interface IntIterable

select

public MutableIntStack select(IntPredicate predicate)

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 interface IntIterable

Specified by:

select in interface IntStack

Specified by:

select in interface MutableIntStack

Specified by:

select in interface OrderedIntIterable

reject

public MutableIntStack reject(IntPredicate predicate)

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 interface IntIterable

Specified by:

reject in interface IntStack

Specified by:

reject in interface MutableIntStack

Specified by:

reject in interface OrderedIntIterable

collect

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

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 interface IntIterable

Specified by:

collect in interface IntStack

Specified by:

collect in interface MutableIntStack

Specified by:

collect in interface OrderedIntIterable

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

toSortedList

public MutableIntList toSortedList()

Specified by:

toSortedList in interface IntIterable

toSortedArray

public int[] toSortedArray()

Specified by:

toSortedArray in interface IntIterable

toArray

public int[] toArray()

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array.

Specified by:

toArray in interface IntIterable

toArray

public int[] toArray(int[] target)

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 interface IntIterable

toString

public String 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 interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

makeString

public String makeString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

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

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 interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).

Specified by:

appendString in interface PrimitiveIterable

appendString

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

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

toList

public MutableIntList toList()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntList.

Specified by:

toList in interface IntIterable

toSet

public MutableIntSet toSet()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntSet.

Specified by:

toSet in interface IntIterable

toBag

public MutableIntBag toBag()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntBag.

Specified by:

toBag in interface IntIterable

equals

public boolean equals(Object otherStack)

Description copied from interface: IntStack

Follows the same general contract as StackIterable.equals(Object).

Specified by:

equals in interface IntStack

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: IntStack

Follows the same general contract as StackIterable.hashCode().

Specified by:

hashCode in interface IntStack

Overrides:

hashCode in class Object

asLazy

public LazyIntIterable asLazy()

Description copied from interface: IntIterable

Returns a LazyIntIterable adapter wrapping the source IntIterable.

Specified by:

asLazy in interface IntIterable

asUnmodifiable

public MutableIntStack asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableIntStack

asSynchronized

public MutableIntStack asSynchronized()

Specified by:

asSynchronized in interface MutableIntStack

toImmutable

public ImmutableIntStack toImmutable()

Specified by:

toImmutable in interface IntStack

newEmpty

public MutableIntStack newEmpty()

Description copied from interface: MutableIntStack

Creates a new empty mutable version of the same stack type.

Specified by:

newEmpty in interface MutableIntStack

Since:

9.2.

injectInto

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

Specified by:

injectInto in interface IntIterable

chunk

public RichIterable<IntIterable> chunk(int size)

Description copied from interface: IntIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface IntIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing IntIterables of size size, except the last will be truncated if the elements don't divide evenly.

getFirst

public int getFirst()

Specified by:

getFirst in interface OrderedIntIterable

indexOf

public int indexOf(int value)

Specified by:

indexOf in interface OrderedIntIterable

injectIntoWithIndex

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

Specified by:

injectIntoWithIndex in interface OrderedIntIterable

forEachWithIndex

public void forEachWithIndex(IntIntProcedure procedure)

Specified by:

forEachWithIndex in interface OrderedIntIterable

collectWithIndex

public <V> MutableStack<V> collectWithIndex(IntIntToObjectFunction<? extends V> function)

Returns a new MutableStack using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface IntStack

Specified by:

collectWithIndex in interface MutableIntStack

Specified by:

collectWithIndex in interface OrderedIntIterable

Since:

9.1.

collectWithIndex

public <V,
R extends Collection<V>> R collectWithIndex(IntIntToObjectFunction<? extends V> function,
 R target)

Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface OrderedIntIterable

Since:

9.1.