Navigation (Apache Turbine 5.1-SNAPSHOT API)

All Superinterfaces:

Assembler

All Known Implementing Classes:

BaseJspNavigation, LegacyVelocityNavigation, TemplateNavigation, VelocityNavigation

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 Navigation
extends Assembler
```
This is the interface that defines what a Navigation 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 navigation cache
`static String`	`CACHE_SIZE_KEY`	Property for the size of the navigation cache if caching is on
`static String`	`NAME`	Represents Navigation Objects
`static String`	`PREFIX`	Prefix for navigation related classes and templates

Method Summary

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

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