org.apache.turbine.modules
Class Page

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.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 222043 2004-12-06 17:47:33Z painter $

Author:

Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

Constructor Summary

Page()

Method Summary

protected void	build(PipelineData pipelineData) Subclasses can override this method to add additional functionality.
protected void	build(RunData data) Deprecated. Use build(PipelineData) instead.
protected void	doBuild(PipelineData pipelineData) A subclass must override this method to build itself.
protected abstract void	doBuild(RunData data) Deprecated. Use doBuild(PipelineData pipelineData) instead

Methods inherited from class org.apache.turbine.modules.Assembler

getRunData

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

Deprecated. Use doBuild(PipelineData pipelineData) instead

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.

doBuild

protected void doBuild(PipelineData pipelineData)
                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. Should revert to abstract when RunData goes.

Parameters:

data - Turbine information.

Throws:

java.lang.Exception - a generic exception.

build

protected void build(RunData data)
              throws java.lang.Exception

Deprecated. Use build(PipelineData) instead.

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.

build

protected void build(PipelineData pipelineData)
              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.