1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_35) on Fri Oct 05 20:53:29 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonRootName (Jackson-annotations 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-05"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="JsonRootName (Jackson-annotations 2.1.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonRootName.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><script type="text/javascript"><!-- 52google_ad_client = "pub-1467773697956887"; 53/* Jackson-ad-small */ 54google_ad_slot = "6699487946"; 55google_ad_width = 234; 56google_ad_height = 60; 57//--> 58</script> 59<script type="text/javascript" 60src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 61</script> 62</TD> 63</TR> 64 65<TR> 66<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 67 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 69<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 70 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonRootName.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonRootName.html" target="_top"><B>NO FRAMES</B></A> 72 <SCRIPT type="text/javascript"> 73 <!-- 74 if(window==top) { 75 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 76 } 77 //--> 78</SCRIPT> 79<NOSCRIPT> 80 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 81</NOSCRIPT> 82 83 84</FONT></TD> 85</TR> 86<TR> 87<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 88 SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | OPTIONAL</FONT></TD> 89<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 90DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 91</TR> 92</TABLE> 93<A NAME="skip-navbar_top"></A> 94<!-- ========= END OF TOP NAVBAR ========= --> 95 96<HR> 97<!-- ======== START OF CLASS DATA ======== --> 98<H2> 99<FONT SIZE="-1"> 100com.fasterxml.jackson.annotation</FONT> 101<BR> 102Annotation Type JsonRootName</H2> 103<HR> 104<DL> 105<DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>={<A HREF="http://download.oracle.com/javase/1.5.0/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://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</A>}) 106<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>) 107</FONT>public @interface <B>JsonRootName</B></DL> 108</PRE> 109 110<P> 111Annotation similar to <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/bind.annotation.XmlRootElement.html?is-external=true" title="class or interface in javax.xml"><CODE>bind.annotation.XmlRootElement</CODE></A>, 112 used to indicate name to use for root-level wrapping, if wrapping is 113 enabled. Annotation itself does not indicate that wrapping should 114 be used; but if it is, name used for serialization should be name 115 specified here, and deserializer will expect the name as well. 116<P> 117 118<P> 119<HR> 120 121<P> 122<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> 123 124<A NAME="annotation_type_required_element_summary"><!-- --></A> 125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 127<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 128<B>Required Element Summary</B></FONT></TH> 129</TR> 130<TR BGCOLOR="white" CLASS="TableRowColor"> 131<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 132<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 133<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonRootName.html#value()">value</A></B></CODE> 134 135<BR> 136 Root name to use if root-level wrapping is enabled.</TD> 137</TR> 138</TABLE> 139 140<P> 141 142<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 143 144<A NAME="annotation_type_element_detail"><!-- --></A> 145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 147<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 148<B>Element Detail</B></FONT></TH> 149</TR> 150</TABLE> 151 152<A NAME="value()"><!-- --></A><H3> 153value</H3> 154<PRE> 155public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>value</B></PRE> 156<DL> 157<DD>Root name to use if root-level wrapping is enabled. 158<P> 159<DD><DL> 160</DL> 161</DD> 162<DD><DL> 163</DL> 164</DL> 165<!-- ========= END OF CLASS DATA ========= --> 166<HR> 167 168 169<!-- ======= START OF BOTTOM NAVBAR ====== --> 170<A NAME="navbar_bottom"><!-- --></A> 171<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 172<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 173<TR><td rowspan='3'><script type="text/javascript"><!-- 174google_ad_client = "pub-1467773697956887"; 175/* Jackson-ad-small */ 176google_ad_slot = "6699487946"; 177google_ad_width = 234; 178google_ad_height = 60; 179//--> 180</script> 181<script type="text/javascript" 182src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 183</script> 184<!-- GA --> 185<script type="text/javascript"> 186var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 187document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 188</script> 189<script type="text/javascript"> 190try { 191var pageTracker = _gat._getTracker("UA-140287-6"); 192pageTracker._trackPageview(); 193} catch(err) {} 194</script> 195</td> 196<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 197<A NAME="navbar_bottom_firstrow"><!-- --></A> 198<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 199 <TR ALIGN="center" VALIGN="top"> 200 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 201 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 202 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonRootName.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 203 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 204 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 205 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 206 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 207 </TR> 208</TABLE> 209</TD> 210<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 211</EM> 212</TD> 213</TR> 214 215<TR> 216<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 217 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 218 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 219<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 220 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonRootName.html" target="_top"><B>FRAMES</B></A> 221 <A HREF="JsonRootName.html" target="_top"><B>NO FRAMES</B></A> 222 <SCRIPT type="text/javascript"> 223 <!-- 224 if(window==top) { 225 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 226 } 227 //--> 228</SCRIPT> 229<NOSCRIPT> 230 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 231</NOSCRIPT> 232 233 234</FONT></TD> 235</TR> 236<TR> 237<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 238 SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | OPTIONAL</FONT></TD> 239<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 240DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 241</TR> 242</TABLE> 243<A NAME="skip-navbar_bottom"></A> 244<!-- ======== END OF BOTTOM NAVBAR ======= --> 245 246<HR> 247Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 248</BODY> 249</HTML> 250