org.apache.turbine.modules

## Class LayoutLoader

- java.lang.Object
- - org.apache.turbine.modules.GenericLoader<Layout>
  - - org.apache.turbine.modules.LayoutLoader

- All Implemented Interfaces:
    Loader<Layout>

      public class LayoutLoader
      extends GenericLoader<Layout>
      implements Loader<Layout>

  The purpose of this class is to allow one to load and execute Layout modules.
  Version:
    $Id: LayoutLoader.java 1773378 2016-12-09 13:19:59Z tv $
  Author:
    Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

- - ### Field Summary

    - ### Fields inherited from class org.apache.turbine.modules.GenericLoader

      `ab`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `exec(PipelineData pipelineData, String name)` Attempts to load and execute the external layout.
    `Layout` | `getAssembler(String name)` Pulls out an instance of the object by name.
    `int` | `getCacheSize()` Get the size of a possibly configured cache
    `static LayoutLoader` | `getInstance()` The method through which this class is accessed.

    - ### Methods inherited from class org.apache.turbine.modules.GenericLoader

      `getAssembler, getBasePackage, getPackages, reload, setReload`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### exec

          public void exec(PipelineData pipelineData,
                  String name)
                    throws Exception

      Attempts to load and execute the external layout.
      Specified by:
        `exec` in class `GenericLoader<Layout>`
      Parameters:
        `pipelineData` - Turbine information.
        `name` - Name of object that will execute the layout.
      Throws:
        `Exception` - a generic exception.

    - #### getAssembler

          public Layout getAssembler(String name)
                              throws Exception

      Pulls out an instance of the object by name. Name is just the single name of the object.
      Specified by:
        `getAssembler` in interface `Loader<Layout>`
      Parameters:
        `name` - Name of object instance.
      Returns:
        A Layout with the specified name, or null.
      Throws:
        `Exception` - a generic exception.

    - #### getCacheSize

          public int getCacheSize()

      Description copied from interface: `Loader`
      Get the size of a possibly configured cache
      Specified by:
        `getCacheSize` in interface `Loader<Layout>`
      Returns:
        the size of the cache in bytes
      See Also:
        `Loader.getCacheSize()`

    - #### getInstance

          public static LayoutLoader getInstance()

      The method through which this class is accessed.
      Returns:
        The single instance of this class.

Copyright © 2000–2018 The Apache Software Foundation. All rights reserved.