http://git-wip-us.apache.org/repos/asf/struts-site/blob/3c135ada/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionContext.html ---------------------------------------------------------------------- diff --git a/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionContext.html b/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionContext.html new file mode 100644 index 0000000..68482b0 --- /dev/null +++ b/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionContext.html @@ -0,0 +1,1024 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_102) on Fri Jul 28 10:21:13 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ActionContext (Struts 2 Core 2.5.12 API)</title> +<meta name="date" content="2017-07-28"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ActionContext (Struts 2 Core 2.5.12 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":9,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ActionContext.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/opensymphony/xwork2/ActionChainResult.html" title="class in com.opensymphony.xwork2"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/opensymphony/xwork2/ActionEventListener.html" title="interface in com.opensymphony.xwork2"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/opensymphony/xwork2/ActionContext.html" target="_top">Frames</a></li> +<li><a href="ActionContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.opensymphony.xwork2</div> +<h2 title="Class ActionContext" class="title">Class ActionContext</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>com.opensymphony.xwork2.ActionContext</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../org/apache/struts2/ServletActionContext.html" title="class in org.apache.struts2">ServletActionContext</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ActionContext</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></pre> +<div class="block"><p> + The ActionContext is the context in which an <a href="../../../com/opensymphony/xwork2/Action.html" title="interface in com.opensymphony.xwork2"><code>Action</code></a> is executed. Each context is basically a + container of objects an action needs for execution like the session, parameters, locale, etc. + </p> + + <p> + The ActionContext is thread local which means that values stored in the ActionContext are + unique per thread. See the <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ThreadLocal.html?is-external=true"; title="class or interface in java.lang"><code>ThreadLocal</code></a> class for more information. The benefit of + this is you don't need to worry about a user specific action context, you just get it: + </p> + + <code>ActionContext context = ActionContext.getContext();</code> + + <p> + Finally, because of the thread local usage you don't need to worry about making your actions thread safe. + </p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Patrick Lightbody, Bill Lynch (docs)</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#com.opensymphony.xwork2.ActionContext">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#ACTION_INVOCATION">ACTION_INVOCATION</a></span></code> +<div class="block">Constant for the action's <a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2"><code>invocation</code></a> context.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#ACTION_NAME">ACTION_NAME</a></span></code> +<div class="block">Constant for the name of the action being executed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#APPLICATION">APPLICATION</a></span></code> +<div class="block">Constant for the action's application context.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#CONTAINER">CONTAINER</a></span></code> +<div class="block">Constant for the container</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#CONVERSION_ERRORS">CONVERSION_ERRORS</a></span></code> +<div class="block">Constant for the map of type conversion errors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#LOCALE">LOCALE</a></span></code> +<div class="block">Constant for the action's locale.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#PARAMETERS">PARAMETERS</a></span></code> +<div class="block">Constant for the action's parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#SESSION">SESSION</a></span></code> +<div class="block">Constant for the action's session.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#TYPE_CONVERTER">TYPE_CONVERTER</a></span></code> +<div class="block">Constant for the action's type converter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#VALUE_STACK">VALUE_STACK</a></span></code> +<div class="block">Constant for the <a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util"><code>OGNL value stack</code></a>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#ActionContext-java.util.Map-">ActionContext</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> context)</code> +<div class="block">Creates a new ActionContext initialized with another context.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key)</code> +<div class="block">Returns a value that is stored in the current ActionContext by doing a lookup using the value's key.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2">ActionInvocation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getActionInvocation--">getActionInvocation</a></span>()</code> +<div class="block">Gets the action invocation (the execution state).</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getApplication--">getApplication</a></span>()</code> +<div class="block">Returns a Map of the ServletContext when in a servlet environment or a generic application level Map otherwise.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../com/opensymphony/xwork2/inject/Container.html" title="interface in com.opensymphony.xwork2.inject">Container</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getContainer--">getContainer</a></span>()</code> +<div class="block">Sets the container for this request</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static <a href="../../../com/opensymphony/xwork2/ActionContext.html" title="class in com.opensymphony.xwork2">ActionContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getContext--">getContext</a></span>()</code> +<div class="block">Returns the ActionContext specific to the current thread.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getContextMap--">getContextMap</a></span>()</code> +<div class="block">Gets the context map.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getConversionErrors--">getConversionErrors</a></span>()</code> +<div class="block">Gets the map of conversion errors which occurred when executing the action.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getInstance-java.lang.Class-">getInstance</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getLocale--">getLocale</a></span>()</code> +<div class="block">Gets the Locale of the current action.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getName--">getName</a></span>()</code> +<div class="block">Gets the name of the current Action.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/struts2/dispatcher/HttpParameters.html" title="class in org.apache.struts2.dispatcher">HttpParameters</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getParameters--">getParameters</a></span>()</code> +<div class="block">Returns a Map of the HttpServletRequest parameters when in a servlet environment or a generic Map of + parameters otherwise.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getSession--">getSession</a></span>()</code> +<div class="block">Gets the Map of HttpSession values when in a servlet environment or a generic session map otherwise.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#getValueStack--">getValueStack</a></span>()</code> +<div class="block">Gets the OGNL value stack.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#put-java.lang.String-java.lang.Object-">put</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Stores a value in the current ActionContext.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setActionInvocation-com.opensymphony.xwork2.ActionInvocation-">setActionInvocation</a></span>(<a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2">ActionInvocation</a> actionInvocation)</code> +<div class="block">Sets the action invocation (the execution state).</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setApplication-java.util.Map-">setApplication</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> application)</code> +<div class="block">Sets the action's application context.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setContainer-com.opensymphony.xwork2.inject.Container-">setContainer</a></span>(<a href="../../../com/opensymphony/xwork2/inject/Container.html" title="interface in com.opensymphony.xwork2.inject">Container</a> cont)</code> +<div class="block">Gets the container for this request</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setContext-com.opensymphony.xwork2.ActionContext-">setContext</a></span>(<a href="../../../com/opensymphony/xwork2/ActionContext.html" title="class in com.opensymphony.xwork2">ActionContext</a> context)</code> +<div class="block">Sets the action context for the current thread.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setContextMap-java.util.Map-">setContextMap</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> contextMap)</code> +<div class="block">Sets the action's context map.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setConversionErrors-java.util.Map-">setConversionErrors</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> conversionErrors)</code> +<div class="block">Sets conversion errors which occurred when executing the action.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setLocale-java.util.Locale-">setLocale</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> +<div class="block">Sets the Locale for the current action.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setName-java.lang.String-">setName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Sets the name of the current Action in the ActionContext.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setParameters-org.apache.struts2.dispatcher.HttpParameters-">setParameters</a></span>(<a href="../../../org/apache/struts2/dispatcher/HttpParameters.html" title="class in org.apache.struts2.dispatcher">HttpParameters</a> parameters)</code> +<div class="block">Sets the action parameters.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setSession-java.util.Map-">setSession</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> session)</code> +<div class="block">Sets a map of action session values.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionContext.html#setValueStack-com.opensymphony.xwork2.util.ValueStack-">setValueStack</a></span>(<a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a> stack)</code> +<div class="block">Sets the OGNL value stack.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="ACTION_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ACTION_NAME</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> ACTION_NAME</pre> +<div class="block">Constant for the name of the action being executed.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.ACTION_NAME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="VALUE_STACK"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALUE_STACK</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> VALUE_STACK</pre> +<div class="block">Constant for the <a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util"><code>OGNL value stack</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.VALUE_STACK">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="SESSION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SESSION</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SESSION</pre> +<div class="block">Constant for the action's session.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.SESSION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="APPLICATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>APPLICATION</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> APPLICATION</pre> +<div class="block">Constant for the action's application context.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.APPLICATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="PARAMETERS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PARAMETERS</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> PARAMETERS</pre> +<div class="block">Constant for the action's parameters.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.PARAMETERS">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="LOCALE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOCALE</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> LOCALE</pre> +<div class="block">Constant for the action's locale.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.LOCALE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_CONVERTER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_CONVERTER</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> TYPE_CONVERTER</pre> +<div class="block">Constant for the action's type converter.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.TYPE_CONVERTER">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="ACTION_INVOCATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ACTION_INVOCATION</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> ACTION_INVOCATION</pre> +<div class="block">Constant for the action's <a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2"><code>invocation</code></a> context.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.ACTION_INVOCATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONVERSION_ERRORS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONVERSION_ERRORS</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> CONVERSION_ERRORS</pre> +<div class="block">Constant for the map of type conversion errors.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.CONVERSION_ERRORS">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONTAINER"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CONTAINER</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> CONTAINER</pre> +<div class="block">Constant for the container</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#com.opensymphony.xwork2.ActionContext.CONTAINER">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ActionContext-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ActionContext</h4> +<pre>public ActionContext(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> context)</pre> +<div class="block">Creates a new ActionContext initialized with another context.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>context</code> - a context map.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setActionInvocation-com.opensymphony.xwork2.ActionInvocation-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setActionInvocation</h4> +<pre>public void setActionInvocation(<a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2">ActionInvocation</a> actionInvocation)</pre> +<div class="block">Sets the action invocation (the execution state).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>actionInvocation</code> - the action execution state.</dd> +</dl> +</li> +</ul> +<a name="getActionInvocation--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActionInvocation</h4> +<pre>public <a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2">ActionInvocation</a> getActionInvocation()</pre> +<div class="block">Gets the action invocation (the execution state).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the action invocation (the execution state).</dd> +</dl> +</li> +</ul> +<a name="setApplication-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApplication</h4> +<pre>public void setApplication(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> application)</pre> +<div class="block">Sets the action's application context.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>application</code> - the action's application context.</dd> +</dl> +</li> +</ul> +<a name="getApplication--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getApplication</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> getApplication()</pre> +<div class="block">Returns a Map of the ServletContext when in a servlet environment or a generic application level Map otherwise.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a Map of ServletContext or generic application level Map</dd> +</dl> +</li> +</ul> +<a name="setContext-com.opensymphony.xwork2.ActionContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setContext</h4> +<pre>public static void setContext(<a href="../../../com/opensymphony/xwork2/ActionContext.html" title="class in com.opensymphony.xwork2">ActionContext</a> context)</pre> +<div class="block">Sets the action context for the current thread.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>context</code> - the action context.</dd> +</dl> +</li> +</ul> +<a name="getContext--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContext</h4> +<pre>public static <a href="../../../com/opensymphony/xwork2/ActionContext.html" title="class in com.opensymphony.xwork2">ActionContext</a> getContext()</pre> +<div class="block">Returns the ActionContext specific to the current thread.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the ActionContext for the current thread, is never <tt>null</tt>.</dd> +</dl> +</li> +</ul> +<a name="setContextMap-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setContextMap</h4> +<pre>public void setContextMap(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> contextMap)</pre> +<div class="block">Sets the action's context map.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>contextMap</code> - the context map.</dd> +</dl> +</li> +</ul> +<a name="getContextMap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContextMap</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> getContextMap()</pre> +<div class="block">Gets the context map.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the context map.</dd> +</dl> +</li> +</ul> +<a name="setConversionErrors-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConversionErrors</h4> +<pre>public void setConversionErrors(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> conversionErrors)</pre> +<div class="block">Sets conversion errors which occurred when executing the action.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>conversionErrors</code> - a Map of errors which occurred when executing the action.</dd> +</dl> +</li> +</ul> +<a name="getConversionErrors--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConversionErrors</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> getConversionErrors()</pre> +<div class="block">Gets the map of conversion errors which occurred when executing the action.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the map of conversion errors which occurred when executing the action or an empty map if + there were no errors.</dd> +</dl> +</li> +</ul> +<a name="setLocale-java.util.Locale-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocale</h4> +<pre>public void setLocale(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</pre> +<div class="block">Sets the Locale for the current action.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>locale</code> - the Locale for the current action.</dd> +</dl> +</li> +</ul> +<a name="getLocale--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocale</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> getLocale()</pre> +<div class="block">Gets the Locale of the current action. If no locale was ever specified the platform's + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true#getDefault--"; title="class or interface in java.util"><code>default locale</code></a> is used.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Locale of the current action.</dd> +</dl> +</li> +</ul> +<a name="setName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Sets the name of the current Action in the ActionContext.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the current action.</dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getName()</pre> +<div class="block">Gets the name of the current Action.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the name of the current action.</dd> +</dl> +</li> +</ul> +<a name="setParameters-org.apache.struts2.dispatcher.HttpParameters-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setParameters</h4> +<pre>public void setParameters(<a href="../../../org/apache/struts2/dispatcher/HttpParameters.html" title="class in org.apache.struts2.dispatcher">HttpParameters</a> parameters)</pre> +<div class="block">Sets the action parameters.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parameters</code> - the parameters for the current action.</dd> +</dl> +</li> +</ul> +<a name="getParameters--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameters</h4> +<pre>public <a href="../../../org/apache/struts2/dispatcher/HttpParameters.html" title="class in org.apache.struts2.dispatcher">HttpParameters</a> getParameters()</pre> +<div class="block">Returns a Map of the HttpServletRequest parameters when in a servlet environment or a generic Map of + parameters otherwise.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a Map of HttpServletRequest parameters or a multipart map when in a servlet environment, or a + generic Map of parameters otherwise.</dd> +</dl> +</li> +</ul> +<a name="setSession-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSession</h4> +<pre>public void setSession(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> session)</pre> +<div class="block">Sets a map of action session values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>session</code> - the session values.</dd> +</dl> +</li> +</ul> +<a name="getSession--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSession</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> getSession()</pre> +<div class="block">Gets the Map of HttpSession values when in a servlet environment or a generic session map otherwise.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Map of HttpSession values when in a servlet environment or a generic session map otherwise.</dd> +</dl> +</li> +</ul> +<a name="setValueStack-com.opensymphony.xwork2.util.ValueStack-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValueStack</h4> +<pre>public void setValueStack(<a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a> stack)</pre> +<div class="block">Sets the OGNL value stack.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stack</code> - the OGNL value stack.</dd> +</dl> +</li> +</ul> +<a name="getValueStack--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValueStack</h4> +<pre>public <a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a> getValueStack()</pre> +<div class="block">Gets the OGNL value stack.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the OGNL value stack.</dd> +</dl> +</li> +</ul> +<a name="setContainer-com.opensymphony.xwork2.inject.Container-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setContainer</h4> +<pre>public void setContainer(<a href="../../../com/opensymphony/xwork2/inject/Container.html" title="interface in com.opensymphony.xwork2.inject">Container</a> cont)</pre> +<div class="block">Gets the container for this request</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cont</code> - The container</dd> +</dl> +</li> +</ul> +<a name="getContainer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContainer</h4> +<pre>public <a href="../../../com/opensymphony/xwork2/inject/Container.html" title="interface in com.opensymphony.xwork2.inject">Container</a> getContainer()</pre> +<div class="block">Sets the container for this request</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The container</dd> +</dl> +</li> +</ul> +<a name="getInstance-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstance</h4> +<pre>public <T> T getInstance(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> +</li> +</ul> +<a name="get-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> get(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key)</pre> +<div class="block">Returns a value that is stored in the current ActionContext by doing a lookup using the value's key.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - the key used to find the value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the value that was found using the key or <tt>null</tt> if the key was not found.</dd> +</dl> +</li> +</ul> +<a name="put-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>put</h4> +<pre>public void put(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Stores a value in the current ActionContext. The value can be looked up using the key.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - the key of the value.</dd> +<dd><code>value</code> - the value to be stored.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ActionContext.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/opensymphony/xwork2/ActionChainResult.html" title="class in com.opensymphony.xwork2"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/opensymphony/xwork2/ActionEventListener.html" title="interface in com.opensymphony.xwork2"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/opensymphony/xwork2/ActionContext.html" target="_top">Frames</a></li> +<li><a href="ActionContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2000–2017 <a href="http://www.apache.org";>Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/struts-site/blob/3c135ada/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionEventListener.html ---------------------------------------------------------------------- diff --git a/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionEventListener.html b/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionEventListener.html new file mode 100644 index 0000000..61c50b3 --- /dev/null +++ b/content/maven/struts2-core/apidocs/com/opensymphony/xwork2/ActionEventListener.html @@ -0,0 +1,261 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_102) on Fri Jul 28 10:21:13 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ActionEventListener (Struts 2 Core 2.5.12 API)</title> +<meta name="date" content="2017-07-28"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ActionEventListener (Struts 2 Core 2.5.12 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ActionEventListener.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/opensymphony/xwork2/ActionContext.html" title="class in com.opensymphony.xwork2"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/opensymphony/xwork2/ActionEventListener.html" target="_top">Frames</a></li> +<li><a href="ActionEventListener.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.opensymphony.xwork2</div> +<h2 title="Interface ActionEventListener" class="title">Interface ActionEventListener</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ActionEventListener</span></pre> +<div class="block">Provides hooks for handling key action events</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionEventListener.html#handleException-java.lang.Throwable-com.opensymphony.xwork2.util.ValueStack-">handleException</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t, + <a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a> stack)</code> +<div class="block">Called when an exception is thrown by the action</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/opensymphony/xwork2/ActionEventListener.html#prepare-java.lang.Object-com.opensymphony.xwork2.util.ValueStack-">prepare</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> action, + <a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a> stack)</code> +<div class="block">Called after an action has been created.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="prepare-java.lang.Object-com.opensymphony.xwork2.util.ValueStack-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> prepare(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> action, + <a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a> stack)</pre> +<div class="block">Called after an action has been created.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>action</code> - The action</dd> +<dd><code>stack</code> - The current value stack</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The action to use</dd> +</dl> +</li> +</ul> +<a name="handleException-java.lang.Throwable-com.opensymphony.xwork2.util.ValueStack-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>handleException</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> handleException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t, + <a href="../../../com/opensymphony/xwork2/util/ValueStack.html" title="interface in com.opensymphony.xwork2.util">ValueStack</a> stack)</pre> +<div class="block">Called when an exception is thrown by the action</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t</code> - The exception/error that was thrown</dd> +<dd><code>stack</code> - The current value stack</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A result code to execute, can be null</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ActionEventListener.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/opensymphony/xwork2/ActionContext.html" title="class in com.opensymphony.xwork2"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../com/opensymphony/xwork2/ActionInvocation.html" title="interface in com.opensymphony.xwork2"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/opensymphony/xwork2/ActionEventListener.html" target="_top">Frames</a></li> +<li><a href="ActionEventListener.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2000–2017 <a href="http://www.apache.org";>Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
