exe
Class GAIGSstack

java.lang.Object
  extended by exe.GAIGSbase
      extended by exe.GAIGSlist
          extended by exe.GAIGSstack
All Implemented Interfaces:
GAIGSdatastr

public class GAIGSstack
extends GAIGSlist

GAIGSstack extends the GAIGSlist class, providing the ability to implement a standard stack data structure and also create GAIGS visualizations of its state. Use the various constructors to specify the general parameters for the stack visualization, and use the toXML method to actually generate the stack XML for snapshots.

A method is also provided to set the presentation color of a stack cell. A default stack cell color can be set by using the appropriate constructor. Methods to get a cell color are inherited from GAIGSlist.

Version:
6/20/06
Author:
Myles McNally (current version)

Field Summary
 
Fields inherited from interface exe.GAIGSdatastr
DEFAULT_COLOR, DEFAULT_FONT_SIZE, DEFAULT_NAME, DEFAULT_X1, DEFAULT_X2, DEFAULT_Y1, DEFAULT_Y2
 
Constructor Summary
GAIGSstack()
          Use all default values for instance variables
GAIGSstack(java.lang.String name, java.lang.String color, double x1, double y1, double x2, double y2, double fontSize)
          Explicitly set all instance variables.
 
Method Summary
 java.lang.Object peek()
          returns but does not remove an item from the stack.
 java.lang.Object pop()
          removes an item from the stack and returns it.
 void push(java.lang.Object v)
          Adds an item to the stack.
 void push(java.lang.Object v, java.lang.String c)
          Adds an item with an associated color to the stack.
 java.lang.String toXML()
          Creates and returns GAIGS XML code for the current state of the stack
 
Methods inherited from class exe.GAIGSlist
add, add, add, add, addFirst, addFirst, addLast, addLast, clear, contains, get, getColor, getFirst, getLast, indexOf, isEmpty, lastIndexOf, remove, remove, removeFirst, removeLast, set, set, setColor, size, toXML
 
Methods inherited from class exe.GAIGSbase
getName, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GAIGSstack

public GAIGSstack()
Use all default values for instance variables


GAIGSstack

public GAIGSstack(java.lang.String name,
                  java.lang.String color,
                  double x1,
                  double y1,
                  double x2,
                  double y2,
                  double fontSize)
Explicitly set all instance variables.

Parameters:
name - Display name of this structure.
color - Color for items unless locally overridden.
x1 - Left display bound.
y1 - Bottom display bound.
x2 - Top display bound.
y2 - Right display bound.
fontSize - Font size for display.
Method Detail

push

public void push(java.lang.Object v)
Adds an item to the stack. Default color will be used for this item.

Parameters:
v - The value to be stored.

push

public void push(java.lang.Object v,
                 java.lang.String c)
Adds an item with an associated color to the stack.

Parameters:
v - The value to be stored.
c - The display color for this item.

pop

public java.lang.Object pop()
removes an item from the stack and returns it.

Returns:
An Object containing popped value

peek

public java.lang.Object peek()
returns but does not remove an item from the stack.

Returns:
An Object containing the next value to be popped.

toXML

public java.lang.String toXML()
Creates and returns GAIGS XML code for the current state of the stack

Specified by:
toXML in interface GAIGSdatastr
Overrides:
toXML in class GAIGSlist
Returns:
A String containing GAIGS XML code for the stack