org.apache.turbine.modules
Class Page

java.lang.Object
  extended byorg.apache.turbine.modules.Assembler
      extended byorg.apache.turbine.modules.Page
Direct Known Subclasses:
DefaultPage

public abstract class Page
extends Assembler

This is the base class that defines what a Page module is.

Version:
$Id: Page.java 264148 2005-08-29 14:21:04Z henning $
Author:
Dave Bryson, Henning P. Schmiedehausen

Constructor Summary
Page()
           
 
Method Summary
protected  void build(RunData data)
          Subclasses can override this method to add additional functionality.
protected abstract  void doBuild(RunData data)
          A subclass must override this method to build itself.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Page

public Page()
Method Detail

doBuild

protected abstract void doBuild(RunData data)
                         throws java.lang.Exception
A subclass must override this method to build itself. Subclasses override this method to store the page in RunData or to write the page to the output stream referenced in RunData.

Parameters:
data - Turbine information.
Throws:
java.lang.Exception - a generic exception.

build

protected void build(RunData data)
              throws java.lang.Exception
Subclasses can override this method to add additional functionality. This method is protected to force clients to use PageLoader to build a Page.

Parameters:
data - Turbine information.
Throws:
java.lang.Exception - a generic exception.


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.