1 package org.apache.turbine.modules;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 import org.apache.turbine.util.RunData;
20
21 /***
22 * This is the base class that defines what a Layout module is.
23 *
24 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
25 * @version $Id: Layout.java 264148 2005-08-29 14:21:04Z henning $
26 */
27 public abstract class Layout
28 extends Assembler
29 {
30 /***
31 * A subclass must override this method to build itself.
32 * Subclasses override this method to store the layout in RunData
33 * or to write the layout to the output stream referenced in
34 * RunData.
35 *
36 * @param data Turbine information.
37 * @exception Exception a generic exception.
38 */
39 protected abstract void doBuild(RunData data)
40 throws Exception;
41
42 /***
43 * Subclasses can override this method to add additional
44 * functionality. This method is protected to force clients to
45 * use LayoutLoader to build a Layout.
46 *
47 * @param data Turbine information.
48 * @exception Exception a generic exception.
49 */
50 protected void build(RunData data)
51 throws Exception
52 {
53 doBuild(data);
54 }
55 }