Stack (ELib API)

Overview Package Class Tree Deprecated Index Help Legend

PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes

java.util
Class Stack

java.lang.Object
 |
 +--java.util.AbstractCollection
 |
 +--java.util.AbstractList
 |
 +--java.util.Vector
 |
 +--java.util.Stack

All Implemented Interfaces:: Cloneable, Collection, List, RandomAccess, Serializable

public class Stack
extends Vector

Untamed:

See Also:: Serialized Form

Field Summary

private static long serialVersionUID
use serialVersionUID from JDK 1.0.2 for interoperability

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Stack()
Enabled: Creates an empty Stack.

Method Summary

boolean empty()
Enabled: Tests if this stack is empty.

Object peek()
Enabled: Looks at the object at the top of this stack without removing it from the stack.

Object pop()
Enabled: Removes the object at the top of this stack and returns that object as the value of this function.

Object push(Object item)
Enabled: Pushes an item onto the top of this stack.

int search(Object o)
Enabled: Returns the 1-based position where an object is on this stack.

Methods inherited from class java.util.Vector

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

Methods inherited from class java.util.AbstractList

iterator, listIterator, listIterator

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

iterator, listIterator, listIterator

Field Detail

serialVersionUID

private static final long serialVersionUID

use serialVersionUID from JDK 1.0.2 for interoperability

Constructor Detail

Stack

public Stack()

Enabled: Creates an empty Stack.

Method Detail

push

public Object push(Object item)

Enabled: Pushes an item onto the top of this stack. This has exactly the same effect as:

 addElement(item)

Parameters:: item - the item to be pushed onto this stack.
Returns:: the item argument.
See Also:: java.util.Vector#addElement

pop

public Object pop()

Enabled: Removes the object at the top of this stack and returns that object as the value of this function.

Returns:: The object at the top of this stack (the last item of the Vector object).

peek

public Object peek()

Enabled: Looks at the object at the top of this stack without removing it from the stack.

Returns:: the object at the top of this stack (the last item of the Vector object).

empty

public boolean empty()

Enabled: Tests if this stack is empty.

Returns:: true if and only if this stack contains no items; false otherwise.

search

public int search(Object o)

Enabled: Returns the 1-based position where an object is on this stack. If the object o occurs as an item in this stack, this method returns the distance from the top of the stack of the occurrence nearest the top of the stack; the topmost item on the stack is considered to be at distance 1. The equals method is used to compare o to the items in this stack.

Parameters:: o - the desired object.
Returns:: the 1-based position from the top of the stack where the object is located; the return value -1 indicates that the object is not on the stack.