ptolemy.backtrack.util.java.util

Class Stack

java.lang.Object

ptolemy.backtrack.util.java.util.AbstractCollection

ptolemy.backtrack.util.java.util.AbstractList

ptolemy.backtrack.util.java.util.Vector

ptolemy.backtrack.util.java.util.Stack

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.RandomAccess, Rollbackable, Collection, List

public class Stack
extends Vector
implements Rollbackable

See Also:

Serialized Form

Field Summary

Fields inherited from class ptolemy.backtrack.util.java.util.AbstractCollection

$CHECKPOINT, $RECORD$$CHECKPOINT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	$COMMIT(long timestamp) Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.
void	$RESTORE(long timestamp, boolean trim) Restore a previous state to all the private fields of this rollbackable object.
boolean	empty() Tests if the stack is empty.
java.lang.Object	peek() Returns the top Object on the stack without removing it.
java.lang.Object	pop() Pops an item from the stack and returns it.
java.lang.Object	push(java.lang.Object item) Pushes an Object onto the top of the stack.
int	search(java.lang.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 ptolemy.backtrack.util.java.util.Vector

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

Methods inherited from class ptolemy.backtrack.util.java.util.AbstractList

getModCount, iterator, listIterator, listIterator, setModCount

Methods inherited from class ptolemy.backtrack.util.java.util.AbstractCollection

$GET$CHECKPOINT, $SET$CHECKPOINT

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.backtrack.Rollbackable

$GET$CHECKPOINT, $SET$CHECKPOINT

Methods inherited from interface ptolemy.backtrack.util.java.util.List

$GET$CHECKPOINT, $SET$CHECKPOINT, iterator, listIterator, listIterator

Constructor Detail

Stack

public Stack()

This constructor creates a new Stack, initially empty

Method Detail

push

public java.lang.Object push(java.lang.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 java.lang.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:

java.util.EmptyStackException - if the stack is empty

peek

public java.lang.Object peek()

Returns the top Object on the stack without removing it.

Returns:

the top Object on the stack

Throws:

java.util.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(java.lang.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

$COMMIT

public void $COMMIT(long timestamp)

Description copied from interface: Rollbackable

Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.

Specified by:

$COMMIT in interface Rollbackable

Specified by:

$COMMIT in interface Collection

Specified by:

$COMMIT in interface List

Overrides:

$COMMIT in class Vector

Parameters:

timestamp - The timestamp.

$RESTORE

public void $RESTORE(long timestamp,
                     boolean trim)

Description copied from interface: Rollbackable

Restore a previous state to all the private fields of this rollbackable object.

Specified by:

$RESTORE in interface Rollbackable

Specified by:

$RESTORE in interface Collection

Specified by:

$RESTORE in interface List

Overrides:

$RESTORE in class Vector

Parameters:

timestamp - The timestamp taken at the time when the previous state was recorded.

trim - Whether to delete the records used for the rollback.

See Also:

Checkpoint.rollback(long, boolean)