org.apache.turbine.modules.navigations.TemplateNavigation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of turbine Show documentation

Turbine is a servlet based framework that allows experienced Java developers to quickly build secure web applications. Parts of Turbine can also be used independently of the web portion of Turbine as well. In other words, we strive to make portions of Turbine easily available for use in other applications.

There is a newer version: 6.0

Show newest version

package org.apache.turbine.modules.navigations;


/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */


import org.apache.turbine.modules.Navigation;
import org.apache.turbine.pipeline.PipelineData;

/**
 * Base Template Navigation.
 *
 * @author Dave Bryson
 * @author Peter Courcoux
 * @version $Id: TemplateNavigation.java 1854786 2019-03-04 18:29:18Z tv $
 */
public abstract class TemplateNavigation implements Navigation
{
    /**
     * WebMacro Navigations extending this class should override this
     * method to perform any particular business logic and add
     * information to the context.
     *
     * @param pipelineData Turbine information.
     * @throws Exception a generic exception.
     */
    protected abstract void doBuildTemplate(PipelineData pipelineData) throws Exception;

    /**
     * This Builds the WebMacro/FreeMarker/etc template.
     * @param pipelineData Turbine information.
     * @return the content of the navigation module
     * @throws Exception a generic exception.
     */
    public abstract String buildTemplate(PipelineData pipelineData) throws Exception;

    /**
     * Calls doBuildTemplate() and then buildTemplate().
     *
     * @param pipelineData Turbine information.
     * @return the content of the navigation module
     * @throws Exception a generic exception.
     */
    @Override
    public String doBuild(PipelineData pipelineData)
            throws Exception
    {
        doBuildTemplate(pipelineData);
        return buildTemplate(pipelineData);
    }
}