Package org.apache.turbine.modules

Schnittstelle Navigation

Alle Superschnittstellen:
Assembler
Alle bekannten Implementierungsklassen:
BaseJspNavigation, LegacyVelocityNavigation, TemplateNavigation, VelocityNavigation
Funktionsschnittstelle:
Dies ist eine funktionale Schnittstelle, die somit als Zuweisungsziel für einen Lambdaausdruck oder eine Methodenreferenz verwendet werden kann.
@FunctionalInterface public interface Navigation extends Assembler
This is the interface that defines what a Navigation module is.
Version:
$Id$
Autor:
Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final int
    CACHE_SIZE_DEFAULT
    The default size for the navigation cache
    static final String
    CACHE_SIZE_KEY
    Property for the size of the navigation cache if caching is on
    static final String
    NAME
    Represents Navigation Objects
    static final String
    PREFIX
    Prefix for navigation related classes and templates

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    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.

  • Felddetails

  • Methodendetails

    • 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.
      Parameter:
      pipelineData - Turbine information.
      Gibt zurück:
      the content of the navigation module
      Löst aus:
      Exception - a generic exception.

    • build

      default String build(PipelineData pipelineData) throws Exception
      Subclasses can override this method to add additional functionality.
      Parameter:
      pipelineData - Turbine information.
      Gibt zurück:
      the content of the navigation module
      Löst aus:
      Exception - a generic exception.