psdi.webclient.system.controller

Class NavigationHistoryStack

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector<E>

java.util.Stack<NavigationHistory>

psdi.webclient.system.controller.NavigationHistoryStack

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<NavigationHistory>, java.util.Collection<NavigationHistory>, java.util.List<NavigationHistory>, java.util.RandomAccess

public class NavigationHistoryStack
extends java.util.Stack<NavigationHistory>

This Stack, like a normal stack, allows for pushing and popping of items, but it also allows you to pop from a given item. NavigationObjects are usually created during a MoveTo operation, to track the movements of a user within the Assets application. The Navigation History can be presented to the user, to allow them to Jump back to a particular Asset.

Author:

sls

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NavigationHistoryStack() Creats a NavigationHistoryManager

Method Summary

Methods

Modifier and Type	Method and Description
NavigationHistory	popHistoryFrom(long navId) Given a NavigationHistory's id, pop it off the history stack and all other NavigationHistory afterwards.
NavigationHistory	push(NavigationHistory object) Pushes a new item on the stack, duplicate items can exist but are unique on the navigation id.

Methods inherited from class java.util.Stack

empty, peek, pop, search

Methods inherited from class java.util.Vector

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NavigationHistoryStack

public NavigationHistoryStack()

Creats a NavigationHistoryManager

Method Detail

popHistoryFrom

public NavigationHistory popHistoryFrom(long navId)

Given a NavigationHistory's id, pop it off the history stack and all other NavigationHistory afterwards. For example, if you have 5 items on the stack [1,2,3,4,5] and you pop item 3, then it will pop [3,4,5] and the new history stack will now contain [1,2].

Parameters:

id - of the NavigationHistory to begin popping off the history stack

push

public NavigationHistory push(NavigationHistory object)

Pushes a new item on the stack, duplicate items can exist but are unique on the navigation id.

Overrides:

push in class java.util.Stack<NavigationHistory>

Returns:

the object that is passed in, (ie, like normal push method)