blob: c8751e2a9d329aec207d1b69cd40da3ac3f5205a [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>VelocityAction.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Apache Turbine</a> &gt; <a href="index.source.html" class="el_package">org.apache.turbine.modules.actions</a> &gt; <span class="el_source">VelocityAction.java</span></div><h1>VelocityAction.java</h1><pre class="source lang-java linenums">package org.apache.turbine.modules.actions;
/*
* 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
* &quot;License&quot;); 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
* &quot;AS IS&quot; 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.screens.TemplateScreen;
import org.apache.turbine.pipeline.PipelineData;
import org.apache.turbine.util.velocity.VelocityActionEvent;
import org.apache.velocity.context.Context;
/**
* This class provides a convenience methods for Velocity Actions to use. Since
* this class is abstract, it should only be extended and not used directly.
*
* @author &lt;a href=&quot;mailto:jon@latchkey.com&quot;&gt;Jon S. Stevens&lt;/a&gt;
* @author &lt;a href=&quot;mailto:jvanzyl@periapt.com&quot;&gt;Jason van Zyl&lt;/a&gt;
* @author &lt;a href=&quot;mailto:peter@courcoux.biz&quot;&gt;Peter Courcoux&lt;/a&gt;
* @version $Id$
*/
<span class="nc" id="L36">public abstract class VelocityAction extends VelocityActionEvent</span>
{
/**
* Initialize the module.
*
* @throws Exception a generic exception.
*/
@Override
public void initialize() throws Exception
{
<span class="nc" id="L46"> initialized = true;</span>
<span class="nc" id="L47"> }</span>
/**
* You SHOULD override this method and implement it in your action.
*
* @param pipelineData Turbine information.
* @param context Context for web pages.
* @throws Exception a generic exception.
*/
public abstract void doPerform(PipelineData pipelineData, Context context)
throws Exception;
/**
* Sets up the context and then calls super.perform(); thus, subclasses
* don't have to worry about getting a context themselves! If a subclass
* throws an exception then depending on whether
* action.event.bubbleexception is true, then it bubbles it farther up, or
* traps it there.
*
* @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
@Override
public void perform(PipelineData pipelineData) throws Exception
{
try
{
<span class="nc" id="L74"> super.perform(pipelineData);</span>
}
<span class="nc" id="L76"> catch (Exception e)</span>
{
<span class="nc bnc" id="L78" title="All 2 branches missed."> if (bubbleUpException)</span>
{
<span class="nc" id="L80"> throw e;</span>
}
<span class="nc" id="L82"> }</span>
<span class="nc" id="L83"> }</span>
/**
* This method is used when you want to short circuit an Action and change
* the template that will be executed next.
*
* @param pipelineData Turbine information.
* @param template The template that will be executed next.
*/
public void setTemplate(PipelineData pipelineData, String template)
{
<span class="nc" id="L94"> TemplateScreen.setTemplate(pipelineData, template);</span>
<span class="nc" id="L95"> }</span>
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.12.202403310830</span></div></body></html>