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