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_29) on Mon Mar 26 18:49:10 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonPropertyOrder (Jackson-annotations 2.0.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-03-26"> 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.0.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><EM> 52</EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyOrder.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="JsonPropertyOrder.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.fasterxml.jackson.annotation</FONT> 92<BR> 93Annotation Type JsonPropertyOrder</H2> 94<HR> 95<DL> 96<DT><PRE><FONT SIZE="-1"><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>}) 97<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>) 98</FONT>public @interface <B>JsonPropertyOrder</B></DL> 99</PRE> 100 101<P> 102Annotation that can be used to define ordering (possibly partial) to use 103 when serializing object properties. Properties included in annotation 104 declaration will be serialized first (in defined order), followed by 105 any properties not included in the definition. 106 Annotation definition will override any implicit orderings (such as 107 guarantee that Creator-properties are serialized before non-creator 108 properties) 109<p> 110 Examples: 111<pre> 112 // ensure that "id" and "name" are output before other properties 113 <div>@</div>JsonPropertyOrder({ "id", "name" }) 114 // order any properties that don't have explicit setting using alphabetic order 115 <div>@</div>JsonPropertyOrder(alphabetic=true) 116</pre> 117<p> 118 This annotation may or may not have effect on deserialization: for basic JSON 119 handling there is no effect, but for other supported data types (or structural 120 conventions) there may be. 121<P> 122 123<P> 124<HR> 125 126<P> 127<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 128 129<A NAME="annotation_type_optional_element_summary"><!-- --></A> 130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 133<B>Optional Element Summary</B></FONT></TH> 134</TR> 135<TR BGCOLOR="white" CLASS="TableRowColor"> 136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 137<CODE> boolean</CODE></FONT></TD> 138<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html#alphabetic()">alphabetic</A></B></CODE> 139 140<BR> 141 Property that defines what to do regarding ordering of properties 142 not explicitly included in annotation instance.</TD> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 146<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></FONT></TD> 147<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html#value()">value</A></B></CODE> 148 149<BR> 150 Order in which properties of annotated object are to be serialized in.</TD> 151</TR> 152</TABLE> 153 154<P> 155<A NAME="value()"><!-- --></A><H3> 156value</H3> 157<PRE> 158public 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>[] <B>value</B></PRE> 159<DL> 160<DD>Order in which properties of annotated object are to be serialized in. 161<P> 162<DD><DL> 163</DL> 164</DD> 165<DD><DL> 166</DL> 167<DL> 168<DT><B>Default:</B><DD>{}</DD> 169</DL> 170</DL> 171<HR> 172 173<A NAME="alphabetic()"><!-- --></A><H3> 174alphabetic</H3> 175<PRE> 176public abstract boolean <B>alphabetic</B></PRE> 177<DL> 178<DD>Property that defines what to do regarding ordering of properties 179 not explicitly included in annotation instance. If set to true, 180 they will be alphabetically ordered; if false, order is 181 undefined (default setting) 182<P> 183<DD><DL> 184</DL> 185</DD> 186<DD><DL> 187</DL> 188<DL> 189<DT><B>Default:</B><DD>false</DD> 190</DL> 191</DL> 192<!-- ========= END OF CLASS DATA ========= --> 193<HR> 194 195 196<!-- ======= START OF BOTTOM NAVBAR ====== --> 197<A NAME="navbar_bottom"><!-- --></A> 198<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 199<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 200<TR> 201<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 202<A NAME="navbar_bottom_firstrow"><!-- --></A> 203<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 204 <TR ALIGN="center" VALIGN="top"> 205 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 206 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 207 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonPropertyOrder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 209 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 210 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 211 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 212 </TR> 213</TABLE> 214</TD> 215<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 216</EM> 217</TD> 218</TR> 219 220<TR> 221<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 222 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 223 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 224<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 225 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyOrder.html" target="_top"><B>FRAMES</B></A> 226 <A HREF="JsonPropertyOrder.html" target="_top"><B>NO FRAMES</B></A> 227 <SCRIPT type="text/javascript"> 228 <!-- 229 if(window==top) { 230 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 231 } 232 //--> 233</SCRIPT> 234<NOSCRIPT> 235 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 236</NOSCRIPT> 237 238 239</FONT></TD> 240</TR> 241<TR> 242<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 243 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 244<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 245DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 246</TR> 247</TABLE> 248<A NAME="skip-navbar_bottom"></A> 249<!-- ======== END OF BOTTOM NAVBAR ======= --> 250 251<HR> 252Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 253</BODY> 254</HTML> 255