de.unkrig.commons.util.collections.Stack Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of de-unkrig-commons Show documentation

A versatile Java(TM) library that implements many useful container and utility classes.

There is a newer version: 1.1.12


/*
 * de.unkrig.commons - A general-purpose Java class library
 *
 * Copyright (c) 2015, Arno Unkrig
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *       following disclaimer in the documentation and/or other materials provided with the distribution.
 *    3. The name of the author may not be used to endorse or promote products derived from this software without
 *       specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package de.unkrig.commons.util.collections;

import java.util.Collection;
import java.util.NoSuchElementException;

/**
 * The interface for an (unsynchronized) "stack", which is painfully missing from {@code java.util}.
 * 
 *   The iteration order of the elements is (typically, but not necessarily) least-recently-added to
 *   most-recently-added.
 * 
 *
 * @param  The element type
 */
public
interface Stack extends Collection {

    /**
     * Pushes a value on the top of the stack.
     */
    void push(T value);

    /**
     * Removes and returns the element on the top of the stack.
     *
     * @throws NoSuchElementException The stack is empty
     */
    T pop();

    /**
     * @return The element on the top of the stack
     * @throws NoSuchElementException The stack is empty
     */
    T peek();
}