/*
 * Copyright (c) 2018 Goldman Sachs and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.api.stack.primitive;

import org.eclipse.collections.api.block.function.primitive.IntIntToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.IntToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.IntPredicate;
import org.eclipse.collections.api.block.procedure.primitive.IntProcedure;
import org.eclipse.collections.api.list.primitive.IntList;
import org.eclipse.collections.api.stack.MutableStack;

This file was automatically generated from template file mutablePrimitiveStack.stg.
Since:3.0.
/** * This file was automatically generated from template file mutablePrimitiveStack.stg. * * @since 3.0. */
public interface MutableIntStack extends IntStack {
Adds an item to the top of the stack.
/** * Adds an item to the top of the stack. */
void push(int item);
Removes and returns the top element of the stack.
/** * Removes and returns the top element of the stack. */
int pop();
Removes and returns a IntList of the number of elements specified by the count, beginning with the top of the stack.
/** * Removes and returns a IntList of the number of elements specified by the count, beginning with the top of the stack. */
IntList pop(int count);
Clears the Stack
/** * Clears the Stack */
void clear(); @Override MutableIntStack select(IntPredicate predicate); @Override MutableIntStack reject(IntPredicate predicate);
Since:9.0.
/** * @since 9.0. */
@Override default MutableIntStack tap(IntProcedure procedure) { this.forEach(procedure); return this; } @Override <V> MutableStack<V> collect(IntToObjectFunction<? extends V> function);
Returns a new MutableStack using results obtained by applying the specified function to each element and its corresponding index.
Since:9.1.
/** * Returns a new MutableStack using results obtained by applying the specified function to each element * and its corresponding index. * * @since 9.1. */
@Override default <V> MutableStack<V> collectWithIndex(IntIntToObjectFunction<? extends V> function) { int[] index = { 0 }; return this.collect(each -> function.value(each, index[0]++)); } MutableIntStack asUnmodifiable(); MutableIntStack asSynchronized();
Creates a new empty mutable version of the same stack type.
Since:9.2.
/** * Creates a new empty mutable version of the same stack type. * * @since 9.2. */
default MutableIntStack newEmpty() { throw new UnsupportedOperationException("Implement in concrete classes."); } }