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

Class UnmodifiableShortStack

java.lang.Object

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

All Implemented Interfaces:

Serializable, OrderedShortIterable, PrimitiveIterable, ShortIterable, MutableShortStack, ShortStack

public class UnmodifiableShortStack
extends Object
implements MutableShortStack, Serializable

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

Since:

3.1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableShortStack(MutableShortStack stack)

Method Summary

Modifier and Type	Method	Description
boolean	allSatisfy(ShortPredicate predicate)	Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(ShortPredicate predicate)	Returns true if any of the elements in the ShortIterable 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.
LazyShortIterable	asLazy()	Returns a LazyShortIterable adapter wrapping the source ShortIterable.
MutableShortStack	asSynchronized()
MutableShortStack	asUnmodifiable()
double	average()
RichIterable<ShortIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()	Clears the Stack
<V> MutableStack<V>	collect(ShortToObjectFunction<? 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(ShortIntToObjectFunction<? 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(ShortIntToObjectFunction<? 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(short value)	Returns true if the value is contained in the ShortIterable, and false if it is not.
boolean	containsAll(short... source)	Returns true if the all of the values specified in the source array are contained in the ShortIterable, and false if they are not.
boolean	containsAll(ShortIterable source)	Returns true if the all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.
int	count(ShortPredicate predicate)	Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.
short	detectIfNone(ShortPredicate predicate, short ifNone)
void	each(ShortProcedure procedure)	A synonym for forEach.
boolean	equals(Object otherStack)	Follows the same general contract as StackIterable.equals(Object).
void	forEach(ShortProcedure procedure)	Applies the ShortProcedure to each element in the ShortIterable.
void	forEachWithIndex(ShortIntProcedure procedure)
short	getFirst()
int	hashCode()	Follows the same general contract as StackIterable.hashCode().
int	indexOf(short value)
<T> T	injectInto(T injectedValue, ObjectShortToObjectFunction<? super T,? extends T> function)
<T> T	injectIntoWithIndex(T injectedValue, ObjectShortIntToObjectFunction<? super T,? extends T> function)
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.
short	max()
short	maxIfEmpty(short defaultValue)
double	median()
short	min()
short	minIfEmpty(short defaultValue)
MutableShortStack	newEmpty()	Creates a new empty mutable version of the same stack type.
boolean	noneSatisfy(ShortPredicate predicate)	Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
short	peek()	Returns the top of the stack.
ShortList	peek(int count)	Returns ShortList of the number of elements specified by the count, beginning with the top of the stack.
short	peekAt(int index)	Returns the element at the specified index.
short	pop()	Removes and returns the top element of the stack.
ShortList	pop(int count)	Removes and returns a ShortList of the number of elements specified by the count, beginning with the top of the stack.
void	push(short item)	Adds an item to the top of the stack.
MutableShortStack	reject(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
MutableShortStack	select(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.
ShortIterator	shortIterator()	Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.
int	size()	Returns the number of items in this iterable.
long	sum()
short[]	toArray()	Converts the ShortIterable to a primitive short array.
short[]	toArray(short[] target)	Converts the ShortIterable to a primitive short array.
MutableShortBag	toBag()	Converts the ShortIterable to a new MutableShortBag.
ImmutableShortStack	toImmutable()
MutableShortList	toList()	Converts the ShortIterable to a new MutableShortList.
MutableShortSet	toSet()	Converts the ShortIterable to a new MutableShortSet.
short[]	toSortedArray()
MutableShortList	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.stack.primitive.MutableShortStack

tap

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

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

Constructor Details

UnmodifiableShortStack

public UnmodifiableShortStack(MutableShortStack stack)

Method Details

push

public void push(short item)

Description copied from interface: MutableShortStack

Adds an item to the top of the stack.

Specified by:

push in interface MutableShortStack

pop

public short pop()

Description copied from interface: MutableShortStack

Removes and returns the top element of the stack.

Specified by:

pop in interface MutableShortStack

pop

public ShortList pop(int count)

Description copied from interface: MutableShortStack

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

Specified by:

pop in interface MutableShortStack

peek

public short peek()

Description copied from interface: ShortStack

Returns the top of the stack.

Specified by:

peek in interface ShortStack

peek

public ShortList peek(int count)

Description copied from interface: ShortStack

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

Specified by:

peek in interface ShortStack

peekAt

public short peekAt(int index)

Description copied from interface: ShortStack

Returns the element at the specified index.

Specified by:

peekAt in interface ShortStack

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: MutableShortStack

Clears the Stack

Specified by:

clear in interface MutableShortStack

contains

public boolean contains(short value)

Description copied from interface: ShortIterable

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

Specified by:

contains in interface ShortIterable

containsAll

public boolean containsAll(short... source)

Description copied from interface: ShortIterable

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

Specified by:

containsAll in interface ShortIterable

containsAll

public boolean containsAll(ShortIterable source)

Description copied from interface: ShortIterable

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

Specified by:

containsAll in interface ShortIterable

shortIterator

public ShortIterator shortIterator()

Description copied from interface: ShortIterable

Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.

Specified by:

shortIterator in interface ShortIterable

forEach

public void forEach(ShortProcedure procedure)

Description copied from interface: ShortIterable

Applies the ShortProcedure to each element in the ShortIterable.

Specified by:

forEach in interface ShortIterable

each

public void each(ShortProcedure procedure)

Description copied from interface: ShortIterable

A synonym for forEach.

Specified by:

each in interface ShortIterable

Since:

7.0.

count

public int count(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.

Specified by:

count in interface ShortIterable

anySatisfy

public boolean anySatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface ShortIterable

allSatisfy

public boolean allSatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface ShortIterable

noneSatisfy

public boolean noneSatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.

Specified by:

noneSatisfy in interface ShortIterable

detectIfNone

public short detectIfNone(ShortPredicate predicate, short ifNone)

Specified by:

detectIfNone in interface ShortIterable

select

public MutableShortStack select(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.

Specified by:

select in interface MutableShortStack

Specified by:

select in interface OrderedShortIterable

Specified by:

select in interface ShortIterable

Specified by:

select in interface ShortStack

reject

public MutableShortStack reject(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.

Specified by:

reject in interface MutableShortStack

Specified by:

reject in interface OrderedShortIterable

Specified by:

reject in interface ShortIterable

Specified by:

reject in interface ShortStack

collect

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

Description copied from interface: ShortIterable

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 MutableShortStack

Specified by:

collect in interface OrderedShortIterable

Specified by:

collect in interface ShortIterable

Specified by:

collect in interface ShortStack

sum

public long sum()

Specified by:

sum in interface ShortIterable

max

public short max()

Specified by:

max in interface ShortIterable

min

public short min()

Specified by:

min in interface ShortIterable

minIfEmpty

public short minIfEmpty(short defaultValue)

Specified by:

minIfEmpty in interface ShortIterable

maxIfEmpty

public short maxIfEmpty(short defaultValue)

Specified by:

maxIfEmpty in interface ShortIterable

average

public double average()

Specified by:

average in interface ShortIterable

median

public double median()

Specified by:

median in interface ShortIterable

toSortedList

public MutableShortList toSortedList()

Specified by:

toSortedList in interface ShortIterable

toSortedArray

public short[] toSortedArray()

Specified by:

toSortedArray in interface ShortIterable

toArray

public short[] toArray()

Description copied from interface: ShortIterable

Converts the ShortIterable to a primitive short array.

Specified by:

toArray in interface ShortIterable

toArray

public short[] toArray(short[] target)

Description copied from interface: ShortIterable

Converts the ShortIterable to a primitive short 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 ShortIterable

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 MutableShortList toList()

Description copied from interface: ShortIterable

Converts the ShortIterable to a new MutableShortList.

Specified by:

toList in interface ShortIterable

toSet

public MutableShortSet toSet()

Description copied from interface: ShortIterable

Converts the ShortIterable to a new MutableShortSet.

Specified by:

toSet in interface ShortIterable

toBag

public MutableShortBag toBag()

Description copied from interface: ShortIterable

Converts the ShortIterable to a new MutableShortBag.

Specified by:

toBag in interface ShortIterable

equals

public boolean equals(Object otherStack)

Description copied from interface: ShortStack

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

Specified by:

equals in interface ShortStack

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ShortStack

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

Specified by:

hashCode in interface ShortStack

Overrides:

hashCode in class Object

asLazy

public LazyShortIterable asLazy()

Description copied from interface: ShortIterable

Returns a LazyShortIterable adapter wrapping the source ShortIterable.

Specified by:

asLazy in interface ShortIterable

asUnmodifiable

public MutableShortStack asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableShortStack

asSynchronized

public MutableShortStack asSynchronized()

Specified by:

asSynchronized in interface MutableShortStack

toImmutable

public ImmutableShortStack toImmutable()

Specified by:

toImmutable in interface ShortStack

newEmpty

public MutableShortStack newEmpty()

Description copied from interface: MutableShortStack

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

Specified by:

newEmpty in interface MutableShortStack

Since:

9.2.

injectInto

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

Specified by:

injectInto in interface ShortIterable

chunk

public RichIterable<ShortIterable> chunk(int size)

Description copied from interface: ShortIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface ShortIterable

Parameters:

size - the number of elements per chunk

Returns:

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

getFirst

public short getFirst()

Specified by:

getFirst in interface OrderedShortIterable

indexOf

public int indexOf(short value)

Specified by:

indexOf in interface OrderedShortIterable

injectIntoWithIndex

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

Specified by:

injectIntoWithIndex in interface OrderedShortIterable

forEachWithIndex

public void forEachWithIndex(ShortIntProcedure procedure)

Specified by:

forEachWithIndex in interface OrderedShortIterable

collectWithIndex

public <V> MutableStack<V> collectWithIndex(ShortIntToObjectFunction<? 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 MutableShortStack

Specified by:

collectWithIndex in interface OrderedShortIterable

Specified by:

collectWithIndex in interface ShortStack

Since:

9.1.

collectWithIndex

public <V, R extends Collection<V>> R collectWithIndex(ShortIntToObjectFunction<? 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 OrderedShortIterable

Since:

9.1.