blob: 4822bcf872bbdddd63a5b5e5d08b387cdc754731 [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="de"><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>VelocityActionEvent.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.util.velocity</a> &gt; <span class="el_source">VelocityActionEvent.java</span></div><h1>VelocityActionEvent.java</h1><pre class="source lang-java linenums">package org.apache.turbine.util.velocity;
/*
* 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.fulcrum.parser.ParameterParser;
import org.apache.turbine.Turbine;
import org.apache.turbine.annotation.TurbineService;
import org.apache.turbine.modules.ActionEvent;
import org.apache.turbine.pipeline.PipelineData;
import org.apache.turbine.services.velocity.VelocityService;
import org.apache.velocity.context.Context;
/**
* If you are using VelocitySite stuff, then your Action's should
* extend this class instead of extending the ActionEvent class. The
* difference between this class and the ActionEvent class is that
* this class will first attempt to execute one of your doMethod's
* with a constructor like this:
*
* &lt;p&gt;&lt;code&gt;doEvent(RunData data, Context context)&lt;/code&gt;&lt;/p&gt;
*
* &lt;p&gt;It gets the context from the TemplateInfo.getTemplateContext()
* method. If it can't find a method like that, then it will try to
* execute the method without the Context in it.&lt;/p&gt;
*
* @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:hps@intermeta.de&quot;&gt;Henning P. Schmiedehausen&lt;/a&gt;
* @author &lt;a href=&quot;mailto:peter@courcoux.biz&quot;&gt;Peter Courcoux&lt;/a&gt;
* @version $Id$
*/
<span class="fc" id="L51">public abstract class VelocityActionEvent extends ActionEvent</span>
{
/** Injected velocity service */
@TurbineService
protected VelocityService velocity;
/** Indicates whether or not this module has been initialized. */
<span class="fc" id="L58"> protected boolean initialized = false;</span>
/**
* Provides a means of initializing the module.
*
* @throws Exception a generic exception.
*/
protected abstract void initialize()
throws Exception;
/**
* This overrides the default Action.doPerform() to execute the
* doEvent() method. If that fails, then it will execute the
* doPerform() method instead.
*
* @param pipelineData A Turbine RunData object.
* @throws Exception a generic exception.
*/
@Override
public void doPerform(PipelineData pipelineData)
throws Exception
{
<span class="pc bpc" id="L80" title="1 of 2 branches missed."> if (!initialized)</span>
{
<span class="fc" id="L82"> initialize();</span>
}
<span class="fc" id="L85"> ParameterParser pp = pipelineData.get(Turbine.class, ParameterParser.class);</span>
<span class="fc" id="L86"> Context context = velocity.getContext(pipelineData);</span>
<span class="fc" id="L87"> executeEvents(pp, new Class&lt;?&gt;[]{ PipelineData.class, Context.class },</span>
new Object[]{ pipelineData, context });
<span class="fc" id="L89"> }</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>