Top Description Methods
org.eclipse.collections.api.stack.primitive

public Interface CharStack

extends OrderedCharIterable
Known Direct Subinterfaces
org.eclipse.collections.api.stack.primitive.ImmutableCharStack, org.eclipse.collections.api.stack.primitive.MutableCharStack
Imports
org.eclipse.collections.api.block.function.primitive.CharIntToObjectFunction, .CharToObjectFunction, org.eclipse.collections.api.block.predicate.primitive.CharIntPredicate, .CharPredicate, org.eclipse.collections.api.block.procedure.primitive.CharProcedure, org.eclipse.collections.api.list.primitive.CharList, org.eclipse.collections.api.ordered.primitive.OrderedCharIterable, org.eclipse.collections.api.stack.StackIterable

This file was automatically generated from template file primitiveStack.stg.
Since
3.0.

Method Summary

Modifier and TypeMethod and Description
public <V> StackIterable<V>
collect(CharToObjectFunction<? extends V> function)

Redeclares org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.collect.

Returns a new collection with the results of applying the specified function on each element of the source collection.

public default <V> StackIterable<V>
collectWithIndex(CharIntToObjectFunction<? extends V> function)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.collectWithIndex.

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

public boolean
equals(Object o)

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

public int
hashCode()

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

public char
peek()

Returns the top of the stack.

public CharList
peek(int count)

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

public char
peekAt(int
the location to peek into
index
)

Returns the element at the specified index.

public CharStack
reject(CharPredicate predicate)

Redeclares org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.reject.

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

public default CharStack
rejectWithIndex(CharIntPredicate predicate)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.rejectWithIndex.

Returns a new CharStack excluding all elements with corresponding indexes matching the specified predicate.

public CharStack
select(CharPredicate predicate)

Redeclares org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.select.

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

public default CharStack
selectWithIndex(CharIntPredicate predicate)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.selectWithIndex.

Returns a new CharStack including all elements with corresponding indexes matching the specified predicate.

public default CharStack
public ImmutableCharStack
Inherited from org.eclipse.collections.api.ordered.primitive.OrderedCharIterable:
collectWithIndexforEachWithIndexgetFirstindexOfinjectIntoWithIndexrejectWithIndexselectWithIndextoStack

Method Detail

collectback to summary
public <V> StackIterable<V> collect(CharToObjectFunction<? extends V> function)

Redeclares org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.collect.

Doc from org.eclipse.collections.api.CharIterable.collect.

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.

Annotations
@Override
collectWithIndexback to summary
public default <V> StackIterable<V> collectWithIndex(CharIntToObjectFunction<? extends V> function)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.collectWithIndex.

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

Annotations
@Override
Since
9.1.
equalsback to summary
public boolean equals(Object o)

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

Annotations
@Override
hashCodeback to summary
public int hashCode()

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

Annotations
@Override
peekback to summary
public char peek()

Returns the top of the stack.

peekback to summary
public CharList peek(int count)

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

peekAtback to summary
public char peekAt(int index)

Returns the element at the specified index.

Parameters
index:int

the location to peek into

rejectback to summary
public CharStack reject(CharPredicate predicate)

Redeclares org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.reject.

Doc from org.eclipse.collections.api.CharIterable.reject.

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

Annotations
@Override
rejectWithIndexback to summary
public default CharStack rejectWithIndex(CharIntPredicate predicate)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.rejectWithIndex.

Returns a new CharStack excluding all elements with corresponding indexes matching the specified predicate.

Annotations
@Override
Since
11.1.
selectback to summary
public CharStack select(CharPredicate predicate)

Redeclares org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.select.

Doc from org.eclipse.collections.api.CharIterable.select.

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

Annotations
@Override
selectWithIndexback to summary
public default CharStack selectWithIndex(CharIntPredicate predicate)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.selectWithIndex.

Returns a new CharStack including all elements with corresponding indexes matching the specified predicate.

Annotations
@Override
Since
11.1.
tapback to summary
public default CharStack tap(CharProcedure procedure)

Overrides default org.eclipse.collections.api.CharIterable.tap.

Annotations
@Override
Since
9.0.
toImmutableback to summary
public ImmutableCharStack toImmutable()