|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectPageFlowStack
public class PageFlowStack
Stack for keeping track of a series of nested page flows. When a nested page flow is entered, the previous page flow is pushed onto this stack, which is kept in the user session.
This Stack implements the HttpSessionBindingListener
which will receive a callback when
this is removed from the HttpSession
. At this time, any PageFlowController instances stored
on the stack will be destroyed using the PageFlowManagedObject.destroy(javax.servlet.http.HttpSession)
lifecycle method.
Nested Class Summary | |
---|---|
static class |
PageFlowStack.PushedPageFlow
Wrapper that contains a pushed page flow and information related to it. |
Method Summary | |
---|---|
void |
destroy(HttpServletRequest request)
Destroy the stack of PageFlowController s that have invoked nested page flows. |
static PageFlowStack |
get(HttpServletRequest request)
Deprecated. Use get(HttpServletRequest, ServletContext) instead. |
static PageFlowStack |
get(HttpServletRequest request,
boolean createIfNotExist)
Deprecated. Use get(HttpServletRequest, ServletContext, boolean) instead. |
static PageFlowStack |
get(HttpServletRequest request,
ServletContext servletContext)
Get the stack of nested page flows for the current user session. |
static PageFlowStack |
get(HttpServletRequest request,
ServletContext servletContext,
boolean createIfNotExist)
Get the stack of nested page flows for the current user session. |
boolean |
isEmpty()
Tell whether the stack of nested page flows is empty. |
PageFlowStack.PushedPageFlow |
peek()
Get the most recently-pushed page flow from the stack of nested page flows in the session. |
PageFlowStack.PushedPageFlow |
pop(HttpServletRequest request)
Pop the most recently-pushed page flow from the stack of nested page flows in the session. |
void |
push(PageFlowController pageFlow,
HttpServletRequest request)
Push a page flow onto the stack of nested page flows in the session. |
int |
size()
Get the size of the stack of nested page flows. |
String |
toString()
|
void |
valueBound(HttpSessionBindingEvent event)
Callback for HttpSessionBindingListener -- should not be invoked directly. |
void |
valueUnbound(HttpSessionBindingEvent event)
Callback for HttpSessionBindingListener -- should not be invoked directly. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static PageFlowStack get(HttpServletRequest request, ServletContext servletContext)
request
- the current HttpServletRequest.servletContext
- the current ServletContext.
PageFlowStack.PushedPageFlow
s) for the current user session.public static PageFlowStack get(HttpServletRequest request)
get(HttpServletRequest, ServletContext)
instead.
request
- the current HttpServletRequest.
PageFlowStack.PushedPageFlow
s) for the current user session.public static PageFlowStack get(HttpServletRequest request, ServletContext servletContext, boolean createIfNotExist)
request
- the current HttpServletRequest.servletContext
- the current ServletContext.
PageFlowStack
of nested page flows (PageFlowController
s) for the current user session.public static PageFlowStack get(HttpServletRequest request, boolean createIfNotExist)
get(HttpServletRequest, ServletContext, boolean)
instead.
request
- the current HttpServletRequest
PageFlowStack
of nested page flows (PageFlowController
s) for the current user session.public void destroy(HttpServletRequest request)
PageFlowController
s that have invoked nested page flows.
request
- the current HttpServletRequest.public void push(PageFlowController pageFlow, HttpServletRequest request)
pageFlow
- the page flow to push.request
- the current HttpServletRequest.public PageFlowStack.PushedPageFlow pop(HttpServletRequest request)
request
- the current HttpServletRequest.
PageFlowStack.PushedPageFlow
that represents the popped page flow.public PageFlowStack.PushedPageFlow peek()
PageFlowStack.PushedPageFlow
that represents the page flow at the top of the stack.public boolean isEmpty()
true
if there are no nested page flows on the stack.public int size()
public void valueBound(HttpSessionBindingEvent event)
HttpSessionBindingListener
-- should not be invoked directly.
valueBound
in interface HttpSessionBindingListener
public void valueUnbound(HttpSessionBindingEvent event)
HttpSessionBindingListener
-- should not be invoked directly.
valueUnbound
in interface HttpSessionBindingListener
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |