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>JsonView (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="JsonView (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/JsonView.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/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum 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/JsonView.html" target="_top">Frames</a></li> 51<li><a href="JsonView.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 JsonView" class="title">Annotation Type JsonView</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#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#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</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>}) 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">JsonView</span></pre> 99<div class="block">Annotation used for indicating view(s) that the property 100 that is defined by method or field annotated is part of. 101<p> 102 An example annotation would be: 103<pre> 104 @JsonView(BasicView.class) 105</pre> 106 which would specify that property annotated would be included 107 when processing (serializing, deserializing) View identified 108 by <code>BasicView.class</code> (or its sub-class). 109 If multiple View class identifiers are included, property will 110 be part of all of them. 111<p> 112 Starting with 2.9, it is also possible to use this annotation on 113 POJO classes to indicate the default view(s) for properties of the 114 type, unless overridden by per-property annotation.</div> 115</li> 116</ul> 117</div> 118<div class="summary"> 119<ul class="blockList"> 120<li class="blockList"> 121<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 122<ul class="blockList"> 123<li class="blockList"><a name="annotation.type.optional.element.summary"> 124<!-- --> 125</a> 126<h3>Optional Element Summary</h3> 127<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 128<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 129<tr> 130<th class="colFirst" scope="col">Modifier and Type</th> 131<th class="colLast" scope="col">Optional Element and Description</th> 132</tr> 133<tr class="altColor"> 134<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[]</code></td> 135<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html#value--">value</a></span></code> 136<div class="block">View or views that annotated element is part of.</div> 137</td> 138</tr> 139</table> 140</li> 141</ul> 142</li> 143</ul> 144</div> 145<div class="details"> 146<ul class="blockList"> 147<li class="blockList"> 148<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 149<ul class="blockList"> 150<li class="blockList"><a name="annotation.type.element.detail"> 151<!-- --> 152</a> 153<h3>Element Detail</h3> 154<a name="value--"> 155<!-- --> 156</a> 157<ul class="blockListLast"> 158<li class="blockList"> 159<h4>value</h4> 160<pre>public abstract <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[] value</pre> 161<div class="block">View or views that annotated element is part of. Views are identified 162 by classes, and use expected class inheritance relationship: child 163 views contain all elements parent views have, for example.</div> 164<dl> 165<dt>Default:</dt> 166<dd>{}</dd> 167</dl> 168</li> 169</ul> 170</li> 171</ul> 172</li> 173</ul> 174</div> 175</div> 176<!-- ========= END OF CLASS DATA ========= --> 177<!-- ======= START OF BOTTOM NAVBAR ====== --> 178<div class="bottomNav"><a name="navbar.bottom"> 179<!-- --> 180</a> 181<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 182<a name="navbar.bottom.firstrow"> 183<!-- --> 184</a> 185<ul class="navList" title="Navigation"> 186<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 187<li class="navBarCell1Rev">Class</li> 188<li><a href="class-use/JsonView.html">Use</a></li> 189<li><a href="package-tree.html">Tree</a></li> 190<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 191<li><a href="../../../../index-all.html">Index</a></li> 192<li><a href="../../../../help-doc.html">Help</a></li> 193</ul> 194</div> 195<div class="subNav"> 196<ul class="navList"> 197<li><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 198<li><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 199</ul> 200<ul class="navList"> 201<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonView.html" target="_top">Frames</a></li> 202<li><a href="JsonView.html" target="_top">No Frames</a></li> 203</ul> 204<ul class="navList" id="allclasses_navbar_bottom"> 205<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 206</ul> 207<div> 208<script type="text/javascript"><!-- 209 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 210 if(window==top) { 211 allClassesLink.style.display = "block"; 212 } 213 else { 214 allClassesLink.style.display = "none"; 215 } 216 //--> 217</script> 218</div> 219<div> 220<ul class="subNavList"> 221<li>Summary: </li> 222<li>Field | </li> 223<li>Required | </li> 224<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 225</ul> 226<ul class="subNavList"> 227<li>Detail: </li> 228<li>Field | </li> 229<li><a href="#annotation.type.element.detail">Element</a></li> 230</ul> 231</div> 232<a name="skip.navbar.bottom"> 233<!-- --> 234</a></div> 235<!-- ======== END OF BOTTOM NAVBAR ======= --> 236<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 237</body> 238</html> 239