org.eclipse.collections.api.stack.primitive.MutableCharStack Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections-api Show documentation

There is a newer version: 12.0.0.M3

Show newest version

/*
 * Copyright (c) 2016 Goldman Sachs.
 * 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.CharToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.CharPredicate;
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();

    MutableCharStack select(CharPredicate predicate);

    MutableCharStack reject(CharPredicate predicate);

     MutableStack collect(CharToObjectFunction function);

    MutableCharStack asUnmodifiable();

    MutableCharStack asSynchronized();
}