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

Class UnmodifiableCharStack

java.lang.Object

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

All Implemented Interfaces:

Serializable, CharIterable, OrderedCharIterable, PrimitiveIterable, CharStack, MutableCharStack

public class UnmodifiableCharStack
extends Object
implements MutableCharStack, Serializable

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

Since:

3.1.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableCharStack(MutableCharStack stack)

Method Summary

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

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, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

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

rejectWithIndex, selectWithIndex, tap

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

rejectWithIndex, selectWithIndex

Constructor Details

UnmodifiableCharStack

public UnmodifiableCharStack(MutableCharStack stack)

Method Details

push

public void push(char item)

Description copied from interface: MutableCharStack

Adds an item to the top of the stack.

Specified by:

push in interface MutableCharStack

pop

public char pop()

Description copied from interface: MutableCharStack

Removes and returns the top element of the stack.

Specified by:

pop in interface MutableCharStack

pop

public CharList pop(int count)

Description copied from interface: MutableCharStack

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

Specified by:

pop in interface MutableCharStack

peek

public char peek()

Description copied from interface: CharStack

Returns the top of the stack.

Specified by:

peek in interface CharStack

peek

public CharList peek(int count)

Description copied from interface: CharStack

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

Specified by:

peek in interface CharStack

peekAt

public char peekAt(int index)

Description copied from interface: CharStack

Returns the element at the specified index.

Specified by:

peekAt in interface CharStack

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

Clears the Stack

Specified by:

clear in interface MutableCharStack

contains

public boolean contains(char value)

Description copied from interface: CharIterable

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

Specified by:

contains in interface CharIterable

containsAll

public boolean containsAll(char... source)

Description copied from interface: CharIterable

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

Specified by:

containsAll in interface CharIterable

containsAll

public boolean containsAll(CharIterable source)

Description copied from interface: CharIterable

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

Specified by:

containsAll in interface CharIterable

charIterator

public CharIterator charIterator()

Description copied from interface: CharIterable

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

Specified by:

charIterator in interface CharIterable

each

public void each(CharProcedure procedure)

Description copied from interface: CharIterable

A synonym for forEach.

Specified by:

each in interface CharIterable

Since:

7.0.

count

public int count(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

count in interface CharIterable

anySatisfy

public boolean anySatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

anySatisfy in interface CharIterable

allSatisfy

public boolean allSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

allSatisfy in interface CharIterable

noneSatisfy

public boolean noneSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

noneSatisfy in interface CharIterable

detectIfNone

public char detectIfNone(CharPredicate predicate,
 char ifNone)

Specified by:

detectIfNone in interface CharIterable

select

public MutableCharStack select(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

select in interface CharIterable

Specified by:

select in interface CharStack

Specified by:

select in interface MutableCharStack

Specified by:

select in interface OrderedCharIterable

reject

public MutableCharStack reject(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

reject in interface CharIterable

Specified by:

reject in interface CharStack

Specified by:

reject in interface MutableCharStack

Specified by:

reject in interface OrderedCharIterable

collect

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

Description copied from interface: CharIterable

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 CharIterable

Specified by:

collect in interface CharStack

Specified by:

collect in interface MutableCharStack

Specified by:

collect in interface OrderedCharIterable

sum

public long sum()

Specified by:

sum in interface CharIterable

max

public char max()

Specified by:

max in interface CharIterable

min

public char min()

Specified by:

min in interface CharIterable

minIfEmpty

public char minIfEmpty(char defaultValue)

Specified by:

minIfEmpty in interface CharIterable

maxIfEmpty

public char maxIfEmpty(char defaultValue)

Specified by:

maxIfEmpty in interface CharIterable

average

public double average()

Specified by:

average in interface CharIterable

median

public double median()

Specified by:

median in interface CharIterable

toSortedList

public MutableCharList toSortedList()

Specified by:

toSortedList in interface CharIterable

toSortedArray

public char[] toSortedArray()

Specified by:

toSortedArray in interface CharIterable

toArray

public char[] toArray()

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char array.

Specified by:

toArray in interface CharIterable

toArray

public char[] toArray(char[] target)

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char 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 CharIterable

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

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharList.

Specified by:

toList in interface CharIterable

toSet

public MutableCharSet toSet()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharSet.

Specified by:

toSet in interface CharIterable

toBag

public MutableCharBag toBag()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharBag.

Specified by:

toBag in interface CharIterable

equals

public boolean equals(Object otherStack)

Description copied from interface: CharStack

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

Specified by:

equals in interface CharStack

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharStack

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

Specified by:

hashCode in interface CharStack

Overrides:

hashCode in class Object

asLazy

public LazyCharIterable asLazy()

Description copied from interface: CharIterable

Returns a LazyCharIterable adapter wrapping the source CharIterable.

Specified by:

asLazy in interface CharIterable

asUnmodifiable

public MutableCharStack asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableCharStack

asSynchronized

public MutableCharStack asSynchronized()

Specified by:

asSynchronized in interface MutableCharStack

toImmutable

public ImmutableCharStack toImmutable()

Specified by:

toImmutable in interface CharStack

newEmpty

public MutableCharStack newEmpty()

Description copied from interface: MutableCharStack

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

Specified by:

newEmpty in interface MutableCharStack

Since:

9.2.

injectInto

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

Specified by:

injectInto in interface CharIterable

chunk

public RichIterable<CharIterable> chunk(int size)

Description copied from interface: CharIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface CharIterable

Parameters:

size - the number of elements per chunk

Returns:

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

getFirst

public char getFirst()

Specified by:

getFirst in interface OrderedCharIterable

indexOf

public int indexOf(char value)

Specified by:

indexOf in interface OrderedCharIterable

injectIntoWithIndex

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

Specified by:

injectIntoWithIndex in interface OrderedCharIterable

forEachWithIndex

public void forEachWithIndex(CharIntProcedure procedure)

Specified by:

forEachWithIndex in interface OrderedCharIterable

collectWithIndex

public <V> MutableStack<V> collectWithIndex(CharIntToObjectFunction<? 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 CharStack

Specified by:

collectWithIndex in interface MutableCharStack

Specified by:

collectWithIndex in interface OrderedCharIterable

Since:

9.1.

collectWithIndex

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

Since:

9.1.