Class Stack

---

Object
   |
   --AbstractList
      |
      --Vector
         |
         --Stack

The Stack class represents a last-in-first-out (LIFO) stack of objects. 
 It extends class Vector with five operations that allow a vector to be treated as a stack. 
 The usual push and pop operations are provided, as well as a method to peek at the top 
 item on the stack, a method to test for whether the stack is empty, and a method to search 
 the stack for an item and discover how far it is from the top. 
 <p/>When a stack is first created, it contains no items.

• Package: util
• Since: Japha 1.0
• Author: Ryan Gantt @

Class Variable Summary

Inherited Class Variable Summary

Method Summary

• boolean isEmpty()
  
• the peek()
  
• The pop()
  
• The push()
  
• int search()
  
• void __construct()
  

Inherited Method Summary

Inherited From Class Vector

• addAll()
  
• get()
  
• indexOf()
  
• lastIndexOf()
  
• remove()
  
• removeRange()
  
• set()
  
• subList()
  
• __construct()
  

Inherited From Class AbstractList

• add()
  
• addAll()
  
• equals()
  
• get()
  
• indexOf()
  
• listIterator()
  
• remove()
  
• removeRange()
  
• set()
  
• subList()
  
• __construct()
  

Inherited From Class Object

• clone()
  
• equals()
  
• equalsIgnoreCase()
  
• finalize()
  
• getClass()
  
• toString()
  
• wait()
  

Variable Detail

Method Detail

• boolean isEmpty()
  
  Usage: isEmpty ( )
  
  

  Tests if this stack is empty.

  Parameters

  Info

  • Return: <tt>true</tt> if and only if this stack contains no items; <tt>false</tt> otherwise.
  • Desc: Tests if this stack is empty. @
  
  
• the peek()
  
  Usage: peek ( )
  
  

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

  Parameters

  Info

  • Return: object at the top of this stack (the last item of the <tt>Vector</tt> object). @
  • Access: public
  • Throws: EmptyStackException if this stack is empty. @
  • Desc: Looks at the object at the top of this stack without removing it from the stack. @
  
  
• The pop()
  
  Usage: pop ( )
  
  

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

  Parameters

  Info

  • Return: object at the top of this stack (the last item of the <tt>Vector</tt> object). @
  • Access: public
  • Throws: EmptyStackException if this stack is empty. @
  • Desc: Removes the object at the top of this stack and returns that object as the value of this function. @
  
  
• The push()
  
  Usage: push ( $object )
  
  

  Pushes an item onto the top of this stack.

  Parameters

  • object $object - the object to be added to the top of the stack @

  Info

  • Return: <tt>object</tt> argument. @
  • Access: public
  • See: Vector.addElement(java.lang.Object) @
  • Desc: Pushes an item onto the top of this stack. This has exactly the same effect as: <p/><tt>addElement(item)</tt> @
  
  
• int search()
  
  Usage: search ( $object )
  
  

  Returns the 1-based position where an object is on this stack. 
   If the <tt>object</tt> 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 <tt>object</tt> to the items in this stack.

  Parameters

  • object $object - The desired object. @

  Info

  • Return: 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. @
  • Access: public
  • Desc: Returns the 1-based position where an object is on this stack. @
  
  
• void __construct()
  
  Usage: __construct ( )
  
  

  Overrides: Vector::__construct()

  Creates an empty Stack

  Parameters

  Info

  • Access: public