Layout (Apache Turbine 5.1 API)

All Superinterfaces:

Assembler

All Known Implementing Classes:

DirectResponseLayout, JspLayout, VelocityCachedLayout, VelocityDirectLayout, VelocityLayout, VelocityOnlyLayout, VelocityXslLayout

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 Layout
extends Assembler
```
This is the interface that defines what a Layout module is.

Version:

$Id$

Author:

Dave Bryson, Peter Courcoux

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CACHE_SIZE_DEFAULT`	The default size for the layout cache
`static String`	`CACHE_SIZE_KEY`	Property for the size of the layout cache if caching is on
`static String`	`NAME`	Represents Layout Objects
`static String`	`PREFIX`	Prefix for layout 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 implement this method to perform itself.

- Field Detail
  - PREFIX
```
static final String PREFIX
```
    Prefix for layout related classes and templates
    
    See Also:
    
    Constant Field Values
  - CACHE_SIZE_KEY
```
static final String CACHE_SIZE_KEY
```
    Property for the size of the layout cache if caching is on
    
    See Also:
    
    Constant Field Values
  - CACHE_SIZE_DEFAULT
```
static final int CACHE_SIZE_DEFAULT
```
    The default size for the layout cache
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final String NAME
```
    Represents Layout Objects
    
    See Also:
    
    Constant Field Values
- Method Detail
  - doBuild
```
void doBuild(PipelineData pipelineData)
      throws Exception
```
    A subclass must implement this method to perform itself. The Action can also set the screen that is associated with 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.