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

public Interface IntStack

extends OrderedIntIterable
Known Direct Subinterfaces
org.eclipse.collections.api.stack.primitive.MutableIntStack, org.eclipse.collections.api.stack.primitive.ImmutableIntStack
Imports
org.eclipse.collections.api.block.function.primitive.IntIntToObjectFunction, .IntToObjectFunction, org.eclipse.collections.api.block.predicate.primitive.IntIntPredicate, .IntPredicate, org.eclipse.collections.api.block.procedure.primitive.IntProcedure, org.eclipse.collections.api.list.primitive.IntList, org.eclipse.collections.api.ordered.primitive.OrderedIntIterable, 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(IntToObjectFunction<? extends V> function)

Redeclares org.eclipse.collections.api.ordered.primitive.OrderedIntIterable.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(IntIntToObjectFunction<? extends V> function)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedIntIterable.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 int
peek()

Returns the top of the stack.

public IntList
peek(int count)

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

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

Returns the element at the specified index.

public IntStack
reject(IntPredicate predicate)

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

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

public default IntStack
rejectWithIndex(IntIntPredicate predicate)

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

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

public IntStack
select(IntPredicate predicate)

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

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

public default IntStack
selectWithIndex(IntIntPredicate predicate)

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

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

public default IntStack
public ImmutableIntStack
Inherited from org.eclipse.collections.api.ordered.primitive.OrderedIntIterable:
collectWithIndexforEachWithIndexgetFirstindexOfinjectIntoWithIndexrejectWithIndexselectWithIndextoStack

Method Detail

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

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

Doc from org.eclipse.collections.api.IntIterable.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(IntIntToObjectFunction<? extends V> function)

Overrides default org.eclipse.collections.api.ordered.primitive.OrderedIntIterable.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 int peek()

Returns the top of the stack.

peekback to summary
public IntList peek(int count)

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

peekAtback to summary
public int peekAt(int index)

Returns the element at the specified index.

Parameters
index:int

the location to peek into

rejectback to summary
public IntStack reject(IntPredicate predicate)

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

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

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

Annotations
@Override
rejectWithIndexback to summary
public default IntStack rejectWithIndex(IntIntPredicate predicate)

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

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

Annotations
@Override
Since
11.1.
selectback to summary
public IntStack select(IntPredicate predicate)

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

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

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

Annotations
@Override
selectWithIndexback to summary
public default IntStack selectWithIndex(IntIntPredicate predicate)

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

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

Annotations
@Override
Since
11.1.
tapback to summary
public default IntStack tap(IntProcedure procedure)

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

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