java.util

Class Stack

java.lang.Object

java.util.Vector

java.util.Stack

All Implemented Interfaces:

Serializable, Cloneable, Collection

Direct Known Subclasses:

ObjectCache

public class Stack
extends Vector

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Constructor Summary

Constructors

Constructor and Description
Stack() This constructor creates a new Stack, initially empty

Method Summary

Modifier and Type	Method and Description
boolean	empty() Tests if the stack is empty.
Object	peek() Returns the top Object on the stack without removing it.
Object	pop() Pops an item from the stack and returns it.
Object	push(Object 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

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, firstElement, get, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, setElementAt, setSize, size, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

Stack

public Stack()

This constructor creates a new Stack, initially empty

Method Detail

push

public Object push(Object 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)

pop

public Object 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

peek

public Object 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

empty

public boolean empty()

Tests if the stack is empty.

Returns:

true if the stack contains no items, false otherwise

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