1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="en"> 4<head> 5<!-- Generated by javadoc (version 1.7.0_79) on Tue Jan 23 20:10:05 PST 2018 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonAlias (Jackson-annotations 2.9.0 API)</title> 8<meta name="date" content="2018-01-23"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10</head> 11<body> 12<script type="text/javascript"><!-- 13 if (location.href.indexOf('is-external=true') == -1) { 14 parent.document.title="JsonAlias (Jackson-annotations 2.9.0 API)"; 15 } 16//--> 17</script> 18<noscript> 19<div>JavaScript is disabled on your browser.</div> 20</noscript> 21<!-- ========= START OF TOP NAVBAR ======= --> 22<div class="topNav"><a name="navbar_top"> 23<!-- --> 24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25<!-- --> 26</a> 27<ul class="navList" title="Navigation"> 28<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 29<li class="navBarCell1Rev">Class</li> 30<li><a href="class-use/JsonAlias.html">Use</a></li> 31<li><a href="package-tree.html">Tree</a></li> 32<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 33<li><a href="../../../../index-all.html">Index</a></li> 34<li><a href="../../../../help-doc.html">Help</a></li> 35</ul> 36</div> 37<div class="subNav"> 38<ul class="navList"> 39<li><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonAlias.html" target="_top">Frames</a></li> 44<li><a href="JsonAlias.html" target="_top">No Frames</a></li> 45</ul> 46<ul class="navList" id="allclasses_navbar_top"> 47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 48</ul> 49<div> 50<script type="text/javascript"><!-- 51 allClassesLink = document.getElementById("allclasses_navbar_top"); 52 if(window==top) { 53 allClassesLink.style.display = "block"; 54 } 55 else { 56 allClassesLink.style.display = "none"; 57 } 58 //--> 59</script> 60</div> 61<div> 62<ul class="subNavList"> 63<li>Summary: </li> 64<li>Required | </li> 65<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 66</ul> 67<ul class="subNavList"> 68<li>Detail: </li> 69<li><a href="#annotation_type_element_detail">Element</a></li> 70</ul> 71</div> 72<a name="skip-navbar_top"> 73<!-- --> 74</a></div> 75<!-- ========= END OF TOP NAVBAR ========= --> 76<!-- ======== START OF CLASS DATA ======== --> 77<div class="header"> 78<div class="subTitle">com.fasterxml.jackson.annotation</div> 79<h2 title="Annotation Type JsonAlias" class="title">Annotation Type JsonAlias</h2> 80</div> 81<div class="contentContainer"> 82<div class="description"> 83<ul class="blockList"> 84<li class="blockList"> 85<hr> 86<br> 87<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>}) 88<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) 89public @interface <span class="strong">JsonAlias</span></pre> 90<div class="block">Annotation that can be used to define one or more alternative names for 91 a property, accepted during deserialization as alternative to the official 92 name. Alias information is also exposed during POJO introspection, but has 93 no effect during serialization where primary name is always used. 94<p> 95 Examples: 96<pre> 97public class Info { 98 @JsonAlias({ "n", "Name" }) 99 public String name; 100} 101</pre></div> 102<dl><dt><span class="strong">Since:</span></dt> 103 <dd>2.9</dd></dl> 104</li> 105</ul> 106</div> 107<div class="summary"> 108<ul class="blockList"> 109<li class="blockList"> 110<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 111<ul class="blockList"> 112<li class="blockList"><a name="annotation_type_optional_element_summary"> 113<!-- --> 114</a> 115<h3>Optional Element Summary</h3> 116<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 117<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 118<tr> 119<th class="colFirst" scope="col">Modifier and Type</th> 120<th class="colLast" scope="col">Optional Element and Description</th> 121</tr> 122<tr class="altColor"> 123<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> 124<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonAlias.html#value()">value</a></strong></code> 125<div class="block">One or more secondary names to accept as aliases to the official name.</div> 126</td> 127</tr> 128</table> 129</li> 130</ul> 131</li> 132</ul> 133</div> 134<div class="details"> 135<ul class="blockList"> 136<li class="blockList"> 137<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 138<ul class="blockList"> 139<li class="blockList"><a name="annotation_type_element_detail"> 140<!-- --> 141</a> 142<h3>Element Detail</h3> 143<a name="value()"> 144<!-- --> 145</a> 146<ul class="blockListLast"> 147<li class="blockList"> 148<h4>value</h4> 149<pre>public abstract <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] value</pre> 150<div class="block">One or more secondary names to accept as aliases to the official name.</div> 151<dl> 152<dt>Default:</dt> 153<dd>{}</dd> 154</dl> 155</li> 156</ul> 157</li> 158</ul> 159</li> 160</ul> 161</div> 162</div> 163<!-- ========= END OF CLASS DATA ========= --> 164<!-- ======= START OF BOTTOM NAVBAR ====== --> 165<div class="bottomNav"><a name="navbar_bottom"> 166<!-- --> 167</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 168<!-- --> 169</a> 170<ul class="navList" title="Navigation"> 171<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 172<li class="navBarCell1Rev">Class</li> 173<li><a href="class-use/JsonAlias.html">Use</a></li> 174<li><a href="package-tree.html">Tree</a></li> 175<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 176<li><a href="../../../../index-all.html">Index</a></li> 177<li><a href="../../../../help-doc.html">Help</a></li> 178</ul> 179</div> 180<div class="subNav"> 181<ul class="navList"> 182<li><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 183<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 184</ul> 185<ul class="navList"> 186<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonAlias.html" target="_top">Frames</a></li> 187<li><a href="JsonAlias.html" target="_top">No Frames</a></li> 188</ul> 189<ul class="navList" id="allclasses_navbar_bottom"> 190<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 191</ul> 192<div> 193<script type="text/javascript"><!-- 194 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 195 if(window==top) { 196 allClassesLink.style.display = "block"; 197 } 198 else { 199 allClassesLink.style.display = "none"; 200 } 201 //--> 202</script> 203</div> 204<div> 205<ul class="subNavList"> 206<li>Summary: </li> 207<li>Required | </li> 208<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 209</ul> 210<ul class="subNavList"> 211<li>Detail: </li> 212<li><a href="#annotation_type_element_detail">Element</a></li> 213</ul> 214</div> 215<a name="skip-navbar_bottom"> 216<!-- --> 217</a></div> 218<!-- ======== END OF BOTTOM NAVBAR ======= --> 219<p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 220</body> 221</html> 222