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