Page (Apache Turbine 5.1-SNAPSHOT API)

All Superinterfaces:

Assembler

All Known Implementing Classes:

DefaultPage, JspPage, TemplatePage, VelocityPage

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface Page
extends Assembler
```
This is the interface that defines what a Page module is.

Version:

$Id$

Author:

Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CACHE_SIZE_DEFAULT`	The default size for the page cache
`static String`	`CACHE_SIZE_KEY`	Property for the size of the page cache if caching is on
`static String`	`NAME`	Represents Page Objects
`static String`	`PREFIX`	Prefix for page related classes and templates

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`build(PipelineData pipelineData)`	Subclasses can override this method to add additional functionality.
`void`	`doBuild(PipelineData pipelineData)`	A subclass must override this method to build itself.

- Field Detail
  - PREFIX
```
static final String PREFIX
```
    Prefix for page related classes and templates
    
    See Also:
    
    Constant Field Values
  - CACHE_SIZE_KEY
```
static final String CACHE_SIZE_KEY
```
    Property for the size of the page cache if caching is on
    
    See Also:
    
    Constant Field Values
  - CACHE_SIZE_DEFAULT
```
static final int CACHE_SIZE_DEFAULT
```
    The default size for the page cache
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final String NAME
```
    Represents Page Objects
    
    See Also:
    
    Constant Field Values
- Method Detail
  - doBuild
```
void doBuild(PipelineData pipelineData)
      throws Exception
```
    A subclass must override this method to build itself. Subclasses override this method to store the page in PipelineData or to write the page to the output stream referenced in PipelineData.
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Throws:
    
    Exception - a generic exception.
  - build
```
default void build(PipelineData pipelineData)
            throws Exception
```
    Subclasses can override this method to add additional functionality.
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Throws:
    
    Exception - a generic exception.