Google Git
Sign in
apache / struts-site / 96c1b0f4b7a3472e1f0625ac076685b6d9a43aa9 / . / content / core-developers / result-annotation.html
blob: b587d38426cf75c6cc081221a69e6c3bb7dbee1b [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="Date-Revision-yyyymmdd" content="20140918"/>
<meta http-equiv="Content-Language" content="en"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Result Annotation</title>
<link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css">
<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
<link href="/css/main.css" rel="stylesheet">
<link href="/css/custom.css" rel="stylesheet">
<link href="/highlighter/github-theme.css" rel="stylesheet">
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="/js/community.js"></script>
</head>
<body>
<a href="http://github.com/apache/struts" class="github-ribbon">
<img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub">
</a>
<header>
<nav>
<div role="navigation" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle">
Menu
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a>
</div>
<div id="struts-menu" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Home<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/index.html">Welcome</a></li>
<li><a href="/download.cgi">Download</a></li>
<li><a href="/releases.html">Releases</a></li>
<li><a href="/announce.html">Announcements</a></li>
<li><a href="http://www.apache.org/licenses/">License</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Support<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/mail.html">User Mailing List</a></li>
<li><a href="https://issues.apache.org/jira/browse/WW">Issue Tracker</a></li>
<li><a href="/security.html">Reporting Security Issues</a></li>
<li class="divider"></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li>
<li class="divider"></li>
<li><a href="/maven/project-info.html">Maven Project Info</a></li>
<li><a href="/maven/struts2-core/dependencies.html">Struts Core Dependencies</a></li>
<li><a href="/maven/struts2-plugins/modules.html">Plugin Dependencies</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Documentation<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/birdseye.html">Birds Eye</a></li>
<li><a href="/primer.html">Key Technologies</a></li>
<li><a href="/kickstart.html">Kickstart FAQ</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Home">Wiki</a></li>
<li class="divider"></li>
<li><a href="/getting-started/">Getting Started</a></li>
<li><a href="/security/">Security Guide</a></li>
<li><a href="/core-developers/">Core Developers Guide</a></li>
<li><a href="/tag-developers/">Tag Developers Guide</a></li>
<li><a href="/maven-archetypes/">Maven Archetypes</a></li>
<li><a href="/plugins/">Plugins</a></li>
<li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li>
<li><a href="/tag-developers/tag-reference.html">Tag reference</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li>
<li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Contributing<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/youatstruts.html">You at Struts</a></li>
<li><a href="/helping.html">How to Help FAQ</a></li>
<li><a href="/dev-mail.html">Development Lists</a></li>
<li class="divider"></li>
<li><a href="/submitting-patches.html">Submitting patches</a></li>
<li><a href="/builds.html">Source Code and Builds</a></li>
<li><a href="/coding-standards.html">Coding standards</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Contributors+Guide">Contributors Guide</a></li>
<li class="divider"></li>
<li><a href="/release-guidelines.html">Release Guidelines</a></li>
<li><a href="/bylaws.html">PMC Charter</a></li>
<li><a href="/volunteers.html">Volunteers</a></li>
<li><a href="https://git-wip-us.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
</ul>
</li>
<li class="apache"><a href="http://www.apache.org/"><img src="/img/apache.png"></a></li>
</ul>
</div>
</div>
</div>
</nav>
</header>
<article class="container">
<section class="col-md-12">
<a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a>
<a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/result-annotation.md" title="Edit this page on GitHub">Edit on GitHub</a>
<h1 id="result-annotation">Result Annotation</h1>
<p>The <code class="highlighter-rouge">@Result</code> annotation allows the definition of <code class="highlighter-rouge">Action</code> results in the <code class="highlighter-rouge">Action</code> class rather than an XML file.</p>
<table>
<tbody>
<tr>
<td>The @Result annotation lives at the Action_class_ level and not the method level. This matches what is found in an XML-based Action configuration. <strong>Do not be tempted to annotate your Action’s methods; it will not work.</strong></td>
</tr>
</tbody>
</table>
<table>
<tbody>
<tr>
</tr>
</tbody>
</table>
<p>In order for <code class="highlighter-rouge">@Result</code> and <code class="highlighter-rouge">@Results</code> annotations to be configured correctly you must set the <code class="highlighter-rouge">actionPackages</code> filter <code class="highlighter-rouge">init-param</code> to a comma-separated list of packages containing the annotated <code class="highlighter-rouge">Action</code> classes. See <a href="zero-configuration.html">Zero Configuration</a> for further information; there are <code class="highlighter-rouge">Action</code> class naming conventions if you don’t implement the <code class="highlighter-rouge">Action</code> interface and other tidbits there.</p>
<h2 id="result-annotation-parameters">@Result Annotation Parameters</h2>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">float:right|width=300px</span><span class="p">}</span><span class="w">
</span><span class="p">{</span><span class="err">info</span><span class="p">}</span><span class="w">
</span><span class="err">See</span><span class="w"> </span><span class="err">org.apache.struts</span><span class="mi">2</span><span class="err">.config.Result</span><span class="w"> </span><span class="err">annotation</span><span class="w"> </span><span class="err">JavaDocs.</span><span class="w">
</span><span class="p">{</span><span class="err">info</span><span class="p">}</span><span class="w">
</span><span class="p">{</span><span class="err">float</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<ul>
<li>name - Result name; default <code class="highlighter-rouge">Action.SUCCESS</code></li>
<li>
<p>value - Value of result (result destination)</p>
</li>
<li>
<p>type - Type of result; default <code class="highlighter-rouge">NullResult</code>. For example:</p>
<ul>
<li><code class="highlighter-rouge">NullResult.class</code></li>
<li><code class="highlighter-rouge">FreemarkerResult.class</code></li>
<li><code class="highlighter-rouge">PlainTextResult.class</code></li>
<li><code class="highlighter-rouge">VelocityResult.class</code></li>
<li><code class="highlighter-rouge">ServletDispatcherResult.class</code></li>
<li><code class="highlighter-rouge">ServletRedirectResult.class</code></li>
<li>
<p><code class="highlighter-rouge">ServletActionRedirectResult.class</code> - equivalent to the <code class="highlighter-rouge">redirectAction</code> type in XML config</p>
</li>
<li><code class="highlighter-rouge">TilesResult.class</code></li>
<li>.. (for more result, please consult the API docs, and look for implementations of the XWork <code class="highlighter-rouge">Result</code> interface)</li>
</ul>
</li>
<li>params - An Array of the parameters in the form {key1, value1, key2, value2}</li>
</ul>
<h2 id="result--defining-a-single-result">@Result – Defining a Single Result</h2>
<p>Map the “success” result (explicitly named) to a Tile definition named “/home.page”.</p>
<p><strong>Defining a Single Result</strong></p>
<div class="highlighter-rouge"><pre class="highlight"><code>
@Result(name="success", value="/home.page", type=TilesResult.class)
public class HomeAction extends ActionSupport {
// ...
}
</code></pre>
</div>
<h2 id="results--defining-multiple-results">@Results – Defining Multiple Results</h2>
<p>Defines a set of results for an <code class="highlighter-rouge">Action</code>.</p>
<p><strong>Defining Multiple Results</strong></p>
<div class="highlighter-rouge"><pre class="highlight"><code>
@Results({
@Result(name="success", value="/home.page", type=TilesResult.class),
@Result(name="homeError", value="/homeError.page", type=TilesResult.class)
})
public class HomeAction extends ActionSupport {
// ....
}
</code></pre>
</div>
</section>
</article>
<footer class="container">
<div class="col-md-12">
Copyright &copy; 2000-2017 <a href="http://www.apache.org/">The Apache Software Foundation </a>.
All Rights Reserved.
</div>
<div class="col-md-12">
Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are
trademarks of The Apache Software Foundation.
</div>
<div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/">SoftwareMill</a>.</div>
</footer>
<script>!function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (!d.getElementById(id)) {
js = d.createElement(s);
js.id = id;
js.src = "//platform.twitter.com/widgets.js";
fjs.parentNode.insertBefore(js, fjs);
}
}(document, "script", "twitter-wjs");</script>
<script src="https://apis.google.com/js/platform.js" async="async" defer="defer"></script>
<div id="fb-root"></div>
<script>(function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) return;
js = d.createElement(s);
js.id = id;
js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>
</body>
</html>