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 Sat Apr 25 16:37:31 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonRootName (Jackson-annotations 2.11.0 API)</title> 8<meta name="date" content="2020-04-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="JsonRootName (Jackson-annotations 2.11.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/JsonRootName.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/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.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/JsonRootName.html" target="_top">Frames</a></li> 51<li><a href="JsonRootName.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><a href="#annotation.type.required.element.summary">Required</a> | </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 JsonRootName" class="title">Annotation Type JsonRootName</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#TYPE" title="class or interface in java.lang.annotation">TYPE</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">JsonRootName</span></pre> 99<div class="block">Annotation similar to <code>javax.xml.bind.annotation.XmlRootElement</code>, 100 used to indicate name to use for root-level wrapping, if wrapping is 101 enabled. Annotation itself does not indicate that wrapping should 102 be used; but if it is, name used for serialization should be name 103 specified here, and deserializer will expect the name as well.</div> 104</li> 105</ul> 106</div> 107<div class="summary"> 108<ul class="blockList"> 109<li class="blockList"> 110<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> 111<ul class="blockList"> 112<li class="blockList"><a name="annotation.type.required.element.summary"> 113<!-- --> 114</a> 115<h3>Required Element Summary</h3> 116<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> 117<caption><span>Required 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">Required Element and Description</th> 121</tr> 122<tr class="altColor"> 123<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> 124<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html#value--">value</a></span></code> 125<div class="block">Root name to use if root-level wrapping is enabled.</div> 126</td> 127</tr> 128</table> 129</li> 130</ul> 131<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 132<ul class="blockList"> 133<li class="blockList"><a name="annotation.type.optional.element.summary"> 134<!-- --> 135</a> 136<h3>Optional Element Summary</h3> 137<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 138<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 139<tr> 140<th class="colFirst" scope="col">Modifier and Type</th> 141<th class="colLast" scope="col">Optional Element and Description</th> 142</tr> 143<tr class="altColor"> 144<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> 145<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html#namespace--">namespace</a></span></code> 146<div class="block">Optional namespace to use with data formats that support such 147 concept (specifically XML); if so, used with <a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html#value--"><code>value()</code></a> to 148 construct fully-qualified name.</div> 149</td> 150</tr> 151</table> 152</li> 153</ul> 154</li> 155</ul> 156</div> 157<div class="details"> 158<ul class="blockList"> 159<li class="blockList"> 160<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 161<ul class="blockList"> 162<li class="blockList"><a name="annotation.type.element.detail"> 163<!-- --> 164</a> 165<h3>Element Detail</h3> 166<a name="value--"> 167<!-- --> 168</a> 169<ul class="blockListLast"> 170<li class="blockList"> 171<h4>value</h4> 172<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> 173<div class="block">Root name to use if root-level wrapping is enabled. For data formats 174 that use composite names (XML), this is the "local part" of the name 175 to use.</div> 176</li> 177</ul> 178</li> 179</ul> 180<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 181<ul class="blockList"> 182<li class="blockList"><a name="namespace--"> 183<!-- --> 184</a> 185<ul class="blockListLast"> 186<li class="blockList"> 187<h4>namespace</h4> 188<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> namespace</pre> 189<div class="block">Optional namespace to use with data formats that support such 190 concept (specifically XML); if so, used with <a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html#value--"><code>value()</code></a> to 191 construct fully-qualified name.</div> 192<dl> 193<dt><span class="simpleTagLabel">Since:</span></dt> 194<dd>2.4</dd> 195</dl> 196<dl> 197<dt>Default:</dt> 198<dd>""</dd> 199</dl> 200</li> 201</ul> 202</li> 203</ul> 204</li> 205</ul> 206</div> 207</div> 208<!-- ========= END OF CLASS DATA ========= --> 209<!-- ======= START OF BOTTOM NAVBAR ====== --> 210<div class="bottomNav"><a name="navbar.bottom"> 211<!-- --> 212</a> 213<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 214<a name="navbar.bottom.firstrow"> 215<!-- --> 216</a> 217<ul class="navList" title="Navigation"> 218<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 219<li class="navBarCell1Rev">Class</li> 220<li><a href="class-use/JsonRootName.html">Use</a></li> 221<li><a href="package-tree.html">Tree</a></li> 222<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 223<li><a href="../../../../index-all.html">Index</a></li> 224<li><a href="../../../../help-doc.html">Help</a></li> 225</ul> 226</div> 227<div class="subNav"> 228<ul class="navList"> 229<li><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 230<li><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 231</ul> 232<ul class="navList"> 233<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonRootName.html" target="_top">Frames</a></li> 234<li><a href="JsonRootName.html" target="_top">No Frames</a></li> 235</ul> 236<ul class="navList" id="allclasses_navbar_bottom"> 237<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 238</ul> 239<div> 240<script type="text/javascript"><!-- 241 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 242 if(window==top) { 243 allClassesLink.style.display = "block"; 244 } 245 else { 246 allClassesLink.style.display = "none"; 247 } 248 //--> 249</script> 250</div> 251<div> 252<ul class="subNavList"> 253<li>Summary: </li> 254<li>Field | </li> 255<li><a href="#annotation.type.required.element.summary">Required</a> | </li> 256<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 257</ul> 258<ul class="subNavList"> 259<li>Detail: </li> 260<li>Field | </li> 261<li><a href="#annotation.type.element.detail">Element</a></li> 262</ul> 263</div> 264<a name="skip.navbar.bottom"> 265<!-- --> 266</a></div> 267<!-- ======== END OF BOTTOM NAVBAR ======= --> 268<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 269</body> 270</html> 271