blob: c5a4da10ac005faf0e4c25d32c1ae4c66db4f15f [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>PipelineData.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.pipeline</a> &gt; <span class="el_source">PipelineData.java</span></div><h1>PipelineData.java</h1><pre class="source lang-java linenums">package org.apache.turbine.pipeline;
import java.util.Map;
import org.apache.turbine.util.RunData;
import org.apache.turbine.util.TurbineRuntimeException;
/*
* 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.
*/
/**
* &lt;p&gt;A &lt;b&gt;PipelineData&lt;/b&gt; is a holder for data being passed from one
* Valve to the next.
* The detailed contract for a Valve is included in the description of
* the &lt;code&gt;invoke()&lt;/code&gt; method below.&lt;/p&gt;
*
* &lt;b&gt;HISTORICAL NOTE&lt;/b&gt;: The &quot;PipelineData&quot; name was assigned to this
* holder as it functions similarly to the RunData object, but without
* the additional methods
*
* @author &lt;a href=&quot;mailto:epugh@opensourceconnections.com&quot;&gt;Eric Pugh&lt;/a&gt;
* @author &lt;a href=&quot;mailto:peter@courcoux.biz&quot;&gt;Peter Courcoux&lt;/a&gt;
*/
public interface PipelineData extends AutoCloseable
{
/**
* Put a configured map of objects into the pipeline data object
*
* @param name the key class
* @param value the value map
*/
void put(Class&lt;?&gt; name, Map&lt;Class&lt;?&gt;, ? super Object&gt; value);
/**
* Get the configured map of objects for the given key
*
* @param name the key class
* @return the value map or null if no such key exists
*/
Map&lt;Class&lt;?&gt;, ? super Object&gt; get(Class&lt;?&gt; name);
/**
* Get a value from the configured map of objects for the given keys
*
* @param key the key class
* @param innerKey the key into the value map
*
* @param &lt;T&gt; the type of the inner key
*
* @return the inner value or null if no such keys exist
*/
&lt;T&gt; T get(Class&lt;?&gt; key, Class&lt;T&gt; innerKey);
/**
* Get RunData from PipelineData
*
* @return RunData extracted from PipelineData
*/
default RunData getRunData()
{
<span class="nc bnc" id="L79" title="All 2 branches missed."> if (!(this instanceof RunData))</span>
{
<span class="nc" id="L81"> throw new TurbineRuntimeException(&quot;Cannot cast to rundata from pipeline data.&quot;);</span>
}
<span class="nc" id="L83"> return (RunData) this;</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>