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 (1.8.0_162) on Sat Apr 25 16:37:31 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonPropertyOrder (Jackson-annotations 2.11.0 API)</title> 8<meta name="date" content="2020-04-25"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10<script type="text/javascript" src="../../../../script.js"></script> 11</head> 12<body> 13<script type="text/javascript"><!-- 14 try { 15 if (location.href.indexOf('is-external=true') == -1) { 16 parent.document.title="JsonPropertyOrder (Jackson-annotations 2.11.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22</script> 23<noscript> 24<div>JavaScript is disabled on your browser.</div> 25</noscript> 26<!-- ========= START OF TOP NAVBAR ======= --> 27<div class="topNav"><a name="navbar.top"> 28<!-- --> 29</a> 30<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 31<a name="navbar.top.firstrow"> 32<!-- --> 33</a> 34<ul class="navList" title="Navigation"> 35<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 36<li class="navBarCell1Rev">Class</li> 37<li><a href="class-use/JsonPropertyOrder.html">Use</a></li> 38<li><a href="package-tree.html">Tree</a></li> 39<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 40<li><a href="../../../../index-all.html">Index</a></li> 41<li><a href="../../../../help-doc.html">Help</a></li> 42</ul> 43</div> 44<div class="subNav"> 45<ul class="navList"> 46<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 48</ul> 49<ul class="navList"> 50<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyOrder.html" target="_top">Frames</a></li> 51<li><a href="JsonPropertyOrder.html" target="_top">No Frames</a></li> 52</ul> 53<ul class="navList" id="allclasses_navbar_top"> 54<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 55</ul> 56<div> 57<script type="text/javascript"><!-- 58 allClassesLink = document.getElementById("allclasses_navbar_top"); 59 if(window==top) { 60 allClassesLink.style.display = "block"; 61 } 62 else { 63 allClassesLink.style.display = "none"; 64 } 65 //--> 66</script> 67</div> 68<div> 69<ul class="subNavList"> 70<li>Summary: </li> 71<li>Field | </li> 72<li>Required | </li> 73<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 74</ul> 75<ul class="subNavList"> 76<li>Detail: </li> 77<li>Field | </li> 78<li><a href="#annotation.type.element.detail">Element</a></li> 79</ul> 80</div> 81<a name="skip.navbar.top"> 82<!-- --> 83</a></div> 84<!-- ========= END OF TOP NAVBAR ========= --> 85<!-- ======== START OF CLASS DATA ======== --> 86<div class="header"> 87<div class="subTitle">com.fasterxml.jackson.annotation</div> 88<h2 title="Annotation Type JsonPropertyOrder" class="title">Annotation Type JsonPropertyOrder</h2> 89</div> 90<div class="contentContainer"> 91<div class="description"> 92<ul class="blockList"> 93<li class="blockList"> 94<hr> 95<br> 96<pre><a href="https://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="https://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="https://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="https://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>,<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#CONSTRUCTOR" title="class or interface in java.lang.annotation">CONSTRUCTOR</a>,<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>}) 97 <a href="https://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="https://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="https://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>) 98public @interface <span class="memberNameLabel">JsonPropertyOrder</span></pre> 99<div class="block">Annotation that can be used to define ordering (possibly partial) to use 100 when serializing object properties. Properties included in annotation 101 declaration will be serialized first (in defined order), followed by 102 any properties not included in the definition. 103 Annotation definition will override any implicit orderings (such as 104 guarantee that Creator-properties are serialized before non-creator 105 properties) 106<p> 107 Examples: 108<pre> 109 // ensure that "id" and "name" are output before other properties 110 @JsonPropertyOrder({ "id", "name" }) 111 // order any properties that don't have explicit setting using alphabetic order 112 @JsonPropertyOrder(alphabetic=true) 113</pre> 114<p> 115 This annotation may or may not have effect on deserialization: for basic JSON 116 handling there is no effect, but for other supported data types (or structural 117 conventions) there may be. 118<p> 119 NOTE: annotation is allowed for properties, starting with 2.4, mostly to support 120 alphabetic ordering of <a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> entries.</div> 121</li> 122</ul> 123</div> 124<div class="summary"> 125<ul class="blockList"> 126<li class="blockList"> 127<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 128<ul class="blockList"> 129<li class="blockList"><a name="annotation.type.optional.element.summary"> 130<!-- --> 131</a> 132<h3>Optional Element Summary</h3> 133<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 134<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 135<tr> 136<th class="colFirst" scope="col">Modifier and Type</th> 137<th class="colLast" scope="col">Optional Element and Description</th> 138</tr> 139<tr class="altColor"> 140<td class="colFirst"><code>boolean</code></td> 141<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html#alphabetic--">alphabetic</a></span></code> 142<div class="block">Property that defines what to do regarding ordering of properties 143 not explicitly included in annotation instance.</div> 144</td> 145</tr> 146<tr class="rowColor"> 147<td class="colFirst"><code><a href="https://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> 148<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html#value--">value</a></span></code> 149<div class="block">Order in which properties of annotated object are to be serialized in.</div> 150</td> 151</tr> 152</table> 153</li> 154</ul> 155</li> 156</ul> 157</div> 158<div class="details"> 159<ul class="blockList"> 160<li class="blockList"> 161<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 162<ul class="blockList"> 163<li class="blockList"><a name="annotation.type.element.detail"> 164<!-- --> 165</a> 166<h3>Element Detail</h3> 167<a name="value--"> 168<!-- --> 169</a> 170<ul class="blockList"> 171<li class="blockList"> 172<h4>value</h4> 173<pre>public abstract <a href="https://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> 174<div class="block">Order in which properties of annotated object are to be serialized in.</div> 175<dl> 176<dt>Default:</dt> 177<dd>{}</dd> 178</dl> 179</li> 180</ul> 181</li> 182</ul> 183<ul class="blockList"> 184<li class="blockList"><a name="alphabetic--"> 185<!-- --> 186</a> 187<ul class="blockListLast"> 188<li class="blockList"> 189<h4>alphabetic</h4> 190<pre>public abstract boolean alphabetic</pre> 191<div class="block">Property that defines what to do regarding ordering of properties 192 not explicitly included in annotation instance. If set to true, 193 they will be alphabetically ordered; if false, order is 194 undefined (default setting)</div> 195<dl> 196<dt>Default:</dt> 197<dd>false</dd> 198</dl> 199</li> 200</ul> 201</li> 202</ul> 203</li> 204</ul> 205</div> 206</div> 207<!-- ========= END OF CLASS DATA ========= --> 208<!-- ======= START OF BOTTOM NAVBAR ====== --> 209<div class="bottomNav"><a name="navbar.bottom"> 210<!-- --> 211</a> 212<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 213<a name="navbar.bottom.firstrow"> 214<!-- --> 215</a> 216<ul class="navList" title="Navigation"> 217<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 218<li class="navBarCell1Rev">Class</li> 219<li><a href="class-use/JsonPropertyOrder.html">Use</a></li> 220<li><a href="package-tree.html">Tree</a></li> 221<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 222<li><a href="../../../../index-all.html">Index</a></li> 223<li><a href="../../../../help-doc.html">Help</a></li> 224</ul> 225</div> 226<div class="subNav"> 227<ul class="navList"> 228<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 229<li><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 230</ul> 231<ul class="navList"> 232<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyOrder.html" target="_top">Frames</a></li> 233<li><a href="JsonPropertyOrder.html" target="_top">No Frames</a></li> 234</ul> 235<ul class="navList" id="allclasses_navbar_bottom"> 236<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 237</ul> 238<div> 239<script type="text/javascript"><!-- 240 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 241 if(window==top) { 242 allClassesLink.style.display = "block"; 243 } 244 else { 245 allClassesLink.style.display = "none"; 246 } 247 //--> 248</script> 249</div> 250<div> 251<ul class="subNavList"> 252<li>Summary: </li> 253<li>Field | </li> 254<li>Required | </li> 255<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 256</ul> 257<ul class="subNavList"> 258<li>Detail: </li> 259<li>Field | </li> 260<li><a href="#annotation.type.element.detail">Element</a></li> 261</ul> 262</div> 263<a name="skip.navbar.bottom"> 264<!-- --> 265</a></div> 266<!-- ======== END OF BOTTOM NAVBAR ======= --> 267<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 268</body> 269</html> 270