in scala/collection/mutable
class Stack

class Stack[A]()
extends MutableList[A]
with ScalaObject
Implementing classes or objects:
trait StackProxy[A]()
class SynchronizedStack[A]()

A stack implements a data structure which allows to store and retrieve objects in a last-in-first-out (LIFO) fashion.
Author:
Matthias Zenger
Version:
1.1, 03/05/2004

Method Summary
  def ++=(iter: Iterable[A]): Unit
     Pushes all elements provided by an Iterable object on top of the stack.
  def ++=(it: Iterator[A]): Unit
     Pushes all elements provided by an iterator on top of the stack.
  def +=(elem: A): Unit
     Pushes a single element on top of the stack.
  def clear: Unit
     Removes all elements from the stack.
override def clone(): Stack[A]
     This method clones the stack.
override def elements: Iterator[A]
     Returns an iterator over all elements on the stack.
override def equals(that: Any): Boolean
     Checks if two stacks are structurally identical.
override def hashCode(): Int
     The hashCode method always yields an error, since it is not safe to use mutable stacks as keys in hash tables.
  def isEmpty: Boolean
     Checks if the stack is empty.
  def pop: A
     Removes the top element from the stack.
  def push(elems: A*): Unit
     Pushes a sequence of elements on top of the stack.
override def toList: List[A]
     Creates a list of all stack elements in FIFO order.
override def toString(): String
     Returns a textual representation of a stack as a string.
  def top: A
     Returns the top element of the stack.

Methods inherited from java/lang/Object-class
eq, finalize, getClass, ne, notify, notifyAll, synchronized, wait, wait, wait

Methods inherited from scala/Any-class
!=, ==, asInstanceOf, isInstanceOf, match

Methods inherited from scala/Iterable-class
/:, :\, concat, exists, find, foldLeft, foldRight, forall, foreach, sameElements

Methods inherited from scala/ScalaObject-class
getScalaType

Methods inherited from scala/Seq-class
concat, copyToArray, drop, indexOf, isDefinedAt, lastIndexOf, subseq, take

Methods inherited from scala/collection/mutable/MutableList-class
appendElem, apply, first, get, last, len, length, prependElem, reset, stringPrefix

Method Detail

isEmpty

  def isEmpty: Boolean
Checks if the stack is empty.
Returns:
true, iff there is no element on the stack

+=

  def +=(elem: A): Unit
Pushes a single element on top of the stack.
Parameters:
elem - the element to push onto the stack

++=

  def ++=(iter: Iterable[A]): Unit
Pushes all elements provided by an Iterable object on top of the stack. The elements are pushed in the order they are given out by the iterator.
Parameters:
iter - an iterable object

++=

  def ++=(it: Iterator[A]): Unit
Pushes all elements provided by an iterator on top of the stack. The elements are pushed in the order they are given out by the iterator.
Parameters:
iter - an iterator

push

  def push(elems: A*): Unit
Pushes a sequence of elements on top of the stack. The first element is pushed first, etc.
Parameters:
elems - a sequence of elements

top

  def top: A
Returns the top element of the stack. This method will not remove the element from the stack. An error is signaled if there is no element on the stack.
Returns:
the top element

pop

  def pop: A
Removes the top element from the stack.

clear

  def clear: Unit
Removes all elements from the stack. After this operation completed, the stack will be empty.

elements

  override def elements: Iterator[A]
Returns an iterator over all elements on the stack. This iterator is stable with respect to state changes in the stack object; i.e. such changes will not be reflected in the iterator. The iterator issues elements in the order they were inserted into the stack (FIFO order).
Returns:
an iterator over all stack elements.

toList

  override def toList: List[A]
Creates a list of all stack elements in FIFO order.
Returns:
the created list.

equals

  override def equals(that: Any): Boolean
Checks if two stacks are structurally identical.
Returns:
true, iff both stacks contain the same sequence of elements.

hashCode

  override def hashCode(): Int
The hashCode method always yields an error, since it is not safe to use mutable stacks as keys in hash tables.
Returns:
never.

toString

  override def toString(): String
Returns a textual representation of a stack as a string.
Returns:
the string representation of this stack.

clone

  override def clone(): Stack[A]
This method clones the stack.
Returns:
a stack with the same elements.