1 package org.apache.turbine.modules;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "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.pipeline.PipelineData;
23
24 /**
25 * This is the interface that defines what a Layout module is.
26 *
27 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
28 * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
29 * @version $Id$
30 */
31 @FunctionalInterface
32 public interface Layout extends Assembler
33 {
34 /** Prefix for layout related classes and templates */
35 String PREFIX = "layouts";
36
37 /** Property for the size of the layout cache if caching is on */
38 String CACHE_SIZE_KEY = "layout.cache.size";
39
40 /** The default size for the layout cache */
41 int CACHE_SIZE_DEFAULT = 10;
42
43 /** Represents Layout Objects */
44 String NAME = "layout";
45
46 /**
47 * A subclass must implement this method to perform itself. The
48 * Action can also set the screen that is associated with PipelineData.
49 * @param pipelineData Turbine information.
50 * @throws Exception a generic exception.
51 */
52 void doBuild(PipelineData pipelineData) throws Exception;
53
54 /**
55 * Subclasses can override this method to add additional
56 * functionality.
57 *
58 * @param pipelineData Turbine information.
59 * @throws Exception a generic exception.
60 */
61 default void build(PipelineData pipelineData) throws Exception
62 {
63 doBuild(pipelineData);
64 }
65 }