org.eclipse.collections.api.stack.primitive.MutableCharStack Maven / Gradle / Ivy
/*
* Copyright (c) 2020 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.CharIntToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.CharToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.CharPredicate;
import org.eclipse.collections.api.block.procedure.primitive.CharProcedure;
import org.eclipse.collections.api.list.primitive.CharList;
import org.eclipse.collections.api.stack.MutableStack;
/**
* This file was automatically generated from template file mutablePrimitiveStack.stg.
*
* @since 3.0.
*/
public interface MutableCharStack extends CharStack
{
/**
* Adds an item to the top of the stack.
*/
void push(char item);
/**
* Removes and returns the top element of the stack.
*/
char pop();
/**
* Removes and returns a CharList of the number of elements specified by the count, beginning with the top of the stack.
*/
CharList pop(int count);
/**
* Clears the Stack
*/
void clear();
@Override
MutableCharStack select(CharPredicate predicate);
@Override
MutableCharStack reject(CharPredicate predicate);
/**
* @since 9.0.
*/
@Override
default MutableCharStack tap(CharProcedure procedure)
{
this.forEach(procedure);
return this;
}
@Override
MutableStack collect(CharToObjectFunction function);
/**
* Returns a new MutableStack using results obtained by applying the specified function to each element
* and its corresponding index.
*
* @since 9.1.
*/
@Override
default MutableStack collectWithIndex(CharIntToObjectFunction function)
{
int[] index = { 0 };
return this.collect(each -> function.value(each, index[0]++));
}
MutableCharStack asUnmodifiable();
MutableCharStack asSynchronized();
/**
* Creates a new empty mutable version of the same stack type.
*
* @since 9.2.
*/
default MutableCharStack newEmpty()
{
throw new UnsupportedOperationException("Implement in concrete classes.");
}
}