View Javadoc
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  import org.apache.turbine.util.RunData;
24  
25  /**
26   * This is an interface that defines what an Assembler is. All the current
27   * modules extend off of this class. It is currently empty and future use is yet
28   * to be determined.
29   *
30   * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
31   * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
32   * @version $Id: Assembler.java 1773378 2016-12-09 13:19:59Z tv $
33   */
34  public abstract class Assembler
35  {
36      /**
37       * This can go once RunData is replaced...
38       *
39       * @param pipelineData Turbine request data
40       * @return RunData extracted from PipelineData
41       */
42      public final RunData getRunData(PipelineData pipelineData)
43      {
44          if (!(pipelineData instanceof RunData))
45          {
46              throw new RuntimeException("Can't cast to rundata from pipeline data.");
47          }
48          return (RunData) pipelineData;
49      }
50  
51      /**
52       * Abstract method to provide the prefix for module related classes and
53       * templates
54       *
55       * @return the prefix
56       */
57      public abstract String getPrefix();
58  }