DJDoc v.1.0.0b-1

net.sf.djdoc.action
Class BunchListAction

java.lang.Object
  extended by net.sf.djdoc.action.BunchListAction
All Implemented Interfaces:
Action

public class BunchListAction
extends java.lang.Object
implements Action

The BunchListAction class combines three functionalities:

  1. Its main purpose is to store the last accessed API in the user session (which causes the list of packages of that API to be cached in the session).
  2. If a package hyperlink has been clicked, it registers that hit in both the cached and the persistent packages lists.
  3. If the user's view preference has changed (by expanding or collapsing one of the three packages lists), the action registers that change in both the transient and the persistent user preference settings.


Constructor Summary
BunchListAction()
           
 
Method Summary
 java.lang.Object perform(DjdocRequest req)
          This method stores the name of the the currently accessed API in the user session (which causes the list of packages of that API to be cached in the session).
 void sendResponse(DjdocRequest req, javax.servlet.http.HttpServletResponse res)
          This method simply redirects the response to the "listBunches.jsp" page which displays (up to) three lists of packages of the currently accessed API on the overview-frame page.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BunchListAction

public BunchListAction()
Method Detail

perform

public java.lang.Object perform(DjdocRequest req)
This method stores the name of the the currently accessed API in the user session (which causes the list of packages of that API to be cached in the session). It also registers "package hits" (clicks on one of the package hyperlinks) and "view preference changes" (clicks on one of the collapse/expand buttons) on the overview-frame page.

Specified by:
perform in interface Action
Parameters:
req - The wrapper around the HTTP request
Returns:
null

sendResponse

public void sendResponse(DjdocRequest req,
                         javax.servlet.http.HttpServletResponse res)
                  throws java.io.IOException
This method simply redirects the response to the "listBunches.jsp" page which displays (up to) three lists of packages of the currently accessed API on the overview-frame page.

Specified by:
sendResponse in interface Action
Parameters:
req - The wrapper around the HTTP request
res - The HTTP response connected to the server call
Throws:
java.io.IOException

DJDoc v.1.0.0b-1