    001package org.apache.turbine.modules;
    002
    003/*
    004 * Licensed to the Apache Software Foundation (ASF) under one
    005 * or more contributor license agreements.  See the NOTICE file
    006 * distributed with this work for additional information
    007 * regarding copyright ownership.  The ASF licenses this file
    008 * to you under the Apache License, Version 2.0 (the
    009 * "License"); you may not use this file except in compliance
    010 * with the License.  You may obtain a copy of the License at
    011 *
    012 *   http://www.apache.org/licenses/LICENSE-2.0
    013 *
    014 * Unless required by applicable law or agreed to in writing,
    015 * software distributed under the License is distributed on an
    016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    017 * KIND, either express or implied.  See the License for the
    018 * specific language governing permissions and limitations
    019 * under the License.
    020 */
    021
    022import org.apache.turbine.pipeline.PipelineData;
    023import org.apache.turbine.util.RunData;
    024
    025/**
    026 * This is an interface that defines what an Assembler is. All the current
    027 * modules extend off of this class. It is currently empty and future use is yet
    028 * to be determined.
    029 *
    030 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
    031 * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
    032 * @version $Id: Assembler.java 1773378 2016-12-09 13:19:59Z tv $
    033 */
    034public abstract class Assembler
    035{
    036    /**
    037     * This can go once RunData is replaced...
    038     *
    039     * @param pipelineData Turbine request data
    040     * @return RunData extracted from PipelineData
    041     */
    042    public final RunData getRunData(PipelineData pipelineData)
    043    {
    044        if (!(pipelineData instanceof RunData))
    045        {
    046            throw new RuntimeException("Can't cast to rundata from pipeline data.");
    047        }
    048        return (RunData) pipelineData;
    049    }
    050
    051    /**
    052     * Abstract method to provide the prefix for module related classes and
    053     * templates
    054     *
    055     * @return the prefix
    056     */
    057    public abstract String getPrefix();
    058}