blob: cd2b6a57f95d83d26e1c5fcd2dde983ed1c5c137 [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>TypeConversion 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-2021.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><a href="/contributors/">Contributors Guide</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://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
<li><a href="/updating-website.html">Updating the website</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 class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/type-conversion-annotation.md" title="Edit this page on GitHub">Edit on GitHub</a>
<a href="annotations.html" title="back to Annotations"><< back to Annotations</a>
<h1 id="typeconversion-annotation">TypeConversion Annotation</h1>
<p>This annotation is used for class and application wide conversion rules.</p>
<ul>
<li>
<p>Class wide conversion:</p>
<p>The conversion rules will be assembled in a file called <code class="highlighter-rouge">XXXAction-conversion.properties</code> within the same package
as the related action class.
Set type to: <code class="highlighter-rouge">type = ConversionType.CLASS</code></p>
</li>
<li>
<p>Application wide conversion:</p>
<p>The conversion rules will be assembled within the <code class="highlighter-rouge">xwork-conversion.properties</code> file within the classpath root.
Set type to: <code class="highlighter-rouge">type = ConversionType.APPLICATION</code></p>
</li>
</ul>
<h2 id="usage">Usage</h2>
<p>The <code class="highlighter-rouge">TypeConversion</code> annotation can be applied at property and method level.</p>
<h2 id="parameters">Parameters</h2>
<p> <table summary="">
<thead>
<tr>
<th>Parameter</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>key</td>
<td>no</td>
<td>The annotated property/key name</td>
<td>The optional property name mostly used within TYPE level annotations.</td>
</tr>
<tr>
<td>type</td>
<td>no</td>
<td>ConversionType.CLASS</td>
<td>Enum value of ConversionType. Determines whether the conversion should be applied at application or class level.</td>
</tr>
<tr>
<td>rule</td>
<td>no</td>
<td>ConversionRule.PROPERTY</td>
<td>Enum value of ConversionRule. The ConversionRule can be a property, a Collection or a Map.</td>
</tr>
<tr>
<td>converter</td>
<td>DEPRECATED: either this or value</td>
<td>&nbsp;</td>
<td>The class name of the TypeConverter to be used as converter.</td>
</tr>
<tr>
<td>converterClass</td>
<td>either this or value</td>
<td>&nbsp;</td>
<td>The class of the TypeConverter to be used as converter. XWorkBasicConverter by default.</td>
</tr>
<tr>
<td>value</td>
<td>either converter or this</td>
<td>&nbsp;</td>
<td>The value to set for ConversionRule.KEY_PROPERTY.</td>
</tr>
</tbody>
</table>
</p>
<h2 id="examples">Examples</h2>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nd">@Conversion</span><span class="o">()</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">ConversionAction</span> <span class="kd">implements</span> <span class="n">Action</span> <span class="o">{</span>
<span class="kd">private</span> <span class="n">String</span> <span class="n">convertInt</span><span class="o">;</span>
<span class="kd">private</span> <span class="n">String</span> <span class="n">convertDouble</span><span class="o">;</span>
<span class="kd">private</span> <span class="n">List</span> <span class="n">users</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
<span class="kd">private</span> <span class="n">HashMap</span> <span class="n">keyValues</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
<span class="nd">@TypeConversion</span><span class="o">(</span><span class="n">type</span> <span class="o">=</span> <span class="n">ConversionType</span><span class="o">.</span><span class="na">APPLICATION</span><span class="o">)</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">setConvertInt</span><span class="o">(</span> <span class="n">String</span> <span class="n">convertInt</span> <span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">convertInt</span> <span class="o">=</span> <span class="n">convertInt</span><span class="o">;</span>
<span class="o">}</span>
<span class="nd">@TypeConversion</span><span class="o">(</span><span class="n">converterClass</span> <span class="o">=</span> <span class="n">XWorkBasicConverter</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">setConvertDouble</span><span class="o">(</span> <span class="n">String</span> <span class="n">convertDouble</span> <span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">convertDouble</span> <span class="o">=</span> <span class="n">convertDouble</span><span class="o">;</span>
<span class="o">}</span>
<span class="nd">@TypeConversion</span><span class="o">(</span><span class="n">rule</span> <span class="o">=</span> <span class="n">ConversionRule</span><span class="o">.</span><span class="na">COLLECTION</span><span class="o">,</span> <span class="n">converterClass</span> <span class="o">=</span> <span class="n">String</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">setUsers</span><span class="o">(</span> <span class="n">List</span> <span class="n">users</span> <span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">users</span> <span class="o">=</span> <span class="n">users</span><span class="o">;</span>
<span class="o">}</span>
<span class="nd">@TypeConversion</span><span class="o">(</span><span class="n">rule</span> <span class="o">=</span> <span class="n">ConversionRule</span><span class="o">.</span><span class="na">MAP</span><span class="o">,</span> <span class="n">converterClass</span> <span class="o">=</span> <span class="n">BigInteger</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">setKeyValues</span><span class="o">(</span> <span class="n">HashMap</span> <span class="n">keyValues</span> <span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">keyValues</span> <span class="o">=</span> <span class="n">keyValues</span><span class="o">;</span>
<span class="o">}</span>
<span class="nd">@TypeConversion</span><span class="o">(</span><span class="n">type</span> <span class="o">=</span> <span class="n">ConversionType</span><span class="o">.</span><span class="na">APPLICATION</span><span class="o">,</span> <span class="n">property</span> <span class="o">=</span> <span class="s">"java.util.Date"</span><span class="o">,</span> <span class="n">converterClass</span> <span class="o">=</span> <span class="n">XWorkBasicConverter</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="kd">public</span> <span class="n">String</span> <span class="nf">execute</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
<span class="k">return</span> <span class="n">SUCCESS</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div></div>
</section>
</article>
<footer class="container">
<div class="col-md-12">
Copyright &copy; 2000-2018 <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>