java.util

Class Stack<T>

Implemented Interfaces:
Cloneable, Collection<E>, Iterable<E>, List<E>, RandomAccess, Serializable

public class Stack<T>
extends Vector<T>

See Also:
Serialized Form

Field Summary

Fields inherited from class java.util.Vector<T>

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList<E>

modCount

Constructor Summary

Stack()
This constructor creates a new Stack, initially empty

Method Summary

boolean
empty()
Tests if the stack is empty.
T
peek()
Returns the top Object on the stack without removing it.
T
pop()
Pops an item from the stack and returns it.
T
push(T item)
Pushes an Object onto the top of the stack.
int
search(Object o)
Returns the position of an Object on the stack, with the top most Object being at position 1, and each Object deeper in the stack at depth + 1.

Methods inherited from class java.util.Vector<T>

S[] toArray, add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toString, trimToSize

Methods inherited from class java.util.AbstractList<E>

add, add, addAll, clear, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection<E>

T[] toArray, add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Stack

public Stack()
This constructor creates a new Stack, initially empty

Method Details

empty

public boolean empty()
Tests if the stack is empty.
Returns:
true if the stack contains no items, false otherwise

peek

public T peek()
Returns the top Object on the stack without removing it.
Returns:
the top Object on the stack
Throws:
EmptyStackException - if the stack is empty

pop

public T pop()
Pops an item from the stack and returns it. The item popped is removed from the Stack.
Returns:
the Object popped from the stack
Throws:
EmptyStackException - if the stack is empty

push

public T push(T item)
Pushes an Object onto the top of the stack. This method is effectively the same as addElement(item).
Parameters:
item - the Object to push onto the stack
Returns:
the Object pushed onto the stack
See Also:
Vector.addElement(Object)

search

public int search(Object o)
Returns the position of an Object on the stack, with the top most Object being at position 1, and each Object deeper in the stack at depth + 1.
Parameters:
o - The object to search for
Returns:
The 1 based depth of the Object, or -1 if the Object is not on the stack

Stack.java - Class that provides a Last In First Out (LIFO) datatype, known more commonly as a Stack Copyright (C) 1998, 1999, 2001, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.