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