01: package org.apache.turbine.modules;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21:
22: import org.apache.turbine.util.RunData;
23:
24: /**
25: * This is the base class that defines what a Page module is.
26: *
27: * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
28: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
29: * @version $Id: Page.java 534527 2007-05-02 16:10:59Z tv $
30: */
31: public abstract class Page extends Assembler {
32: /**
33: * A subclass must override this method to build itself.
34: * Subclasses override this method to store the page in RunData or
35: * to write the page to the output stream referenced in RunData.
36: *
37: * @param data Turbine information.
38: * @exception Exception a generic exception.
39: */
40: protected abstract void doBuild(RunData data) 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 PageLoader to build a Page.
46: *
47: * @param data Turbine information.
48: * @exception Exception a generic exception.
49: */
50: protected void build(RunData data) throws Exception {
51: doBuild(data);
52: }
53: }
|