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> 8JsonPropertyOrder (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="JsonPropertyOrder (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/JsonPropertyOrder.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/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRawValue.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/JsonPropertyOrder.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonPropertyOrder.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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></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 JsonPropertyOrder</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>JsonPropertyOrder</B></DL> 108</PRE> 109 110<P> 111Annotation that can be used to define ordering (possibly partial) to use 112 when serializing object properties. Properties included in annotation 113 declaration will be serialized first (in defined order), followed by 114 any properties not included in the definition. 115 Annotation definition will override any implicit orderings (such as 116 guarantee that Creator-properties are serialized before non-creator 117 properties) 118<p> 119 Examples: 120<pre> 121 // ensure that "id" and "name" are output before other properties 122 <div>@</div>JsonPropertyOrder({ "id", "name" }) 123 // order any properties that don't have explicit setting using alphabetic order 124 <div>@</div>JsonPropertyOrder(alphabetic=true) 125</pre> 126<p> 127 This annotation may or may not have effect on deserialization: for basic JSON 128 handling there is no effect, but for other supported data types (or structural 129 conventions) there may be. 130<P> 131 132<P> 133<HR> 134 135<P> 136<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 137 138<A NAME="annotation_type_optional_element_summary"><!-- --></A> 139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 142<B>Optional Element Summary</B></FONT></TH> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 146<CODE> boolean</CODE></FONT></TD> 147<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html#alphabetic()">alphabetic</A></B></CODE> 148 149<BR> 150 Property that defines what to do regarding ordering of properties 151 not explicitly included in annotation instance.</TD> 152</TR> 153<TR BGCOLOR="white" CLASS="TableRowColor"> 154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 155<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> 156<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html#value()">value</A></B></CODE> 157 158<BR> 159 Order in which properties of annotated object are to be serialized in.</TD> 160</TR> 161</TABLE> 162 163<P> 164<A NAME="value()"><!-- --></A><H3> 165value</H3> 166<PRE> 167public 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> 168<DL> 169<DD>Order in which properties of annotated object are to be serialized in. 170<P> 171<DD><DL> 172</DL> 173</DD> 174<DD><DL> 175</DL> 176<DL> 177<DT><B>Default:</B><DD>{}</DD> 178</DL> 179</DL> 180<HR> 181 182<A NAME="alphabetic()"><!-- --></A><H3> 183alphabetic</H3> 184<PRE> 185public abstract boolean <B>alphabetic</B></PRE> 186<DL> 187<DD>Property that defines what to do regarding ordering of properties 188 not explicitly included in annotation instance. If set to true, 189 they will be alphabetically ordered; if false, order is 190 undefined (default setting) 191<P> 192<DD><DL> 193</DL> 194</DD> 195<DD><DL> 196</DL> 197<DL> 198<DT><B>Default:</B><DD>false</DD> 199</DL> 200</DL> 201<!-- ========= END OF CLASS DATA ========= --> 202<HR> 203 204 205<!-- ======= START OF BOTTOM NAVBAR ====== --> 206<A NAME="navbar_bottom"><!-- --></A> 207<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 208<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 209<TR><td rowspan='3'><script type="text/javascript"><!-- 210google_ad_client = "pub-1467773697956887"; 211/* Jackson-ad-small */ 212google_ad_slot = "6699487946"; 213google_ad_width = 234; 214google_ad_height = 60; 215//--> 216</script> 217<script type="text/javascript" 218src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 219</script> 220<!-- GA --> 221<script type="text/javascript"> 222var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 223document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 224</script> 225<script type="text/javascript"> 226try { 227var pageTracker = _gat._getTracker("UA-140287-6"); 228pageTracker._trackPageview(); 229} catch(err) {} 230</script> 231</td> 232<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 233<A NAME="navbar_bottom_firstrow"><!-- --></A> 234<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 235 <TR ALIGN="center" VALIGN="top"> 236 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 237 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 238 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonPropertyOrder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 240 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 241 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 242 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 243 </TR> 244</TABLE> 245</TD> 246<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 247</EM> 248</TD> 249</TR> 250 251<TR> 252<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 253 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 254 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 255<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 256 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyOrder.html" target="_top"><B>FRAMES</B></A> 257 <A HREF="JsonPropertyOrder.html" target="_top"><B>NO FRAMES</B></A> 258 <SCRIPT type="text/javascript"> 259 <!-- 260 if(window==top) { 261 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 262 } 263 //--> 264</SCRIPT> 265<NOSCRIPT> 266 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 267</NOSCRIPT> 268 269 270</FONT></TD> 271</TR> 272<TR> 273<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 274 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 275<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 276DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 277</TR> 278</TABLE> 279<A NAME="skip-navbar_bottom"></A> 280<!-- ======== END OF BOTTOM NAVBAR ======= --> 281 282<HR> 283Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 284</BODY> 285</HTML> 286