• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 (version 1.7.0_79) on Tue Jan 23 20:10:06 PST 2018 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>JsonView (Jackson-annotations 2.9.0 API)</title>
8<meta name="date" content="2018-01-23">
9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
10</head>
11<body>
12<script type="text/javascript"><!--
13    if (location.href.indexOf('is-external=true') == -1) {
14        parent.document.title="JsonView (Jackson-annotations 2.9.0 API)";
15    }
16//-->
17</script>
18<noscript>
19<div>JavaScript is disabled on your browser.</div>
20</noscript>
21<!-- ========= START OF TOP NAVBAR ======= -->
22<div class="topNav"><a name="navbar_top">
23<!--   -->
24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
25<!--   -->
26</a>
27<ul class="navList" title="Navigation">
28<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/JsonView.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../../index-all.html">Index</a></li>
34<li><a href="../../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonView.html" target="_top">Frames</a></li>
44<li><a href="JsonView.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Required&nbsp;|&nbsp;</li>
65<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
66</ul>
67<ul class="subNavList">
68<li>Detail:&nbsp;</li>
69<li><a href="#annotation_type_element_detail">Element</a></li>
70</ul>
71</div>
72<a name="skip-navbar_top">
73<!--   -->
74</a></div>
75<!-- ========= END OF TOP NAVBAR ========= -->
76<!-- ======== START OF CLASS DATA ======== -->
77<div class="header">
78<div class="subTitle">com.fasterxml.jackson.annotation</div>
79<h2 title="Annotation Type JsonView" class="title">Annotation Type JsonView</h2>
80</div>
81<div class="contentContainer">
82<div class="description">
83<ul class="blockList">
84<li class="blockList">
85<hr>
86<br>
87<pre><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#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://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="http://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="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>})
88<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>)
89public @interface <span class="strong">JsonView</span></pre>
90<div class="block">Annotation used for indicating view(s) that the property
91 that is defined by method or field annotated is part of.
92<p>
93 An example annotation would be:
94<pre>
95  &#064;JsonView(BasicView.class)
96</pre>
97 which would specify that property annotated would be included
98 when processing (serializing, deserializing) View identified
99 by <code>BasicView.class</code> (or its sub-class).
100 If multiple View class identifiers are included, property will
101 be part of all of them.
102<p>
103 Starting with 2.9, it is also possible to use this annotation on
104 POJO classes to indicate the default view(s) for properties of the
105 type, unless overridden by per-property annotation.</div>
106</li>
107</ul>
108</div>
109<div class="summary">
110<ul class="blockList">
111<li class="blockList">
112<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
113<ul class="blockList">
114<li class="blockList"><a name="annotation_type_optional_element_summary">
115<!--   -->
116</a>
117<h3>Optional Element Summary</h3>
118<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
119<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
120<tr>
121<th class="colFirst" scope="col">Modifier and Type</th>
122<th class="colLast" scope="col">Optional Element and Description</th>
123</tr>
124<tr class="altColor">
125<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
126<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html#value()">value</a></strong></code>
127<div class="block">View or views that annotated element is part of.</div>
128</td>
129</tr>
130</table>
131</li>
132</ul>
133</li>
134</ul>
135</div>
136<div class="details">
137<ul class="blockList">
138<li class="blockList">
139<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
140<ul class="blockList">
141<li class="blockList"><a name="annotation_type_element_detail">
142<!--   -->
143</a>
144<h3>Element Detail</h3>
145<a name="value()">
146<!--   -->
147</a>
148<ul class="blockListLast">
149<li class="blockList">
150<h4>value</h4>
151<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;value</pre>
152<div class="block">View or views that annotated element is part of. Views are identified
153 by classes, and use expected class inheritance relationship: child
154 views contain all elements parent views have, for example.</div>
155<dl>
156<dt>Default:</dt>
157<dd>{}</dd>
158</dl>
159</li>
160</ul>
161</li>
162</ul>
163</li>
164</ul>
165</div>
166</div>
167<!-- ========= END OF CLASS DATA ========= -->
168<!-- ======= START OF BOTTOM NAVBAR ====== -->
169<div class="bottomNav"><a name="navbar_bottom">
170<!--   -->
171</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
172<!--   -->
173</a>
174<ul class="navList" title="Navigation">
175<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
176<li class="navBarCell1Rev">Class</li>
177<li><a href="class-use/JsonView.html">Use</a></li>
178<li><a href="package-tree.html">Tree</a></li>
179<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
180<li><a href="../../../../index-all.html">Index</a></li>
181<li><a href="../../../../help-doc.html">Help</a></li>
182</ul>
183</div>
184<div class="subNav">
185<ul class="navList">
186<li><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
187<li><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
188</ul>
189<ul class="navList">
190<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonView.html" target="_top">Frames</a></li>
191<li><a href="JsonView.html" target="_top">No Frames</a></li>
192</ul>
193<ul class="navList" id="allclasses_navbar_bottom">
194<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
195</ul>
196<div>
197<script type="text/javascript"><!--
198  allClassesLink = document.getElementById("allclasses_navbar_bottom");
199  if(window==top) {
200    allClassesLink.style.display = "block";
201  }
202  else {
203    allClassesLink.style.display = "none";
204  }
205  //-->
206</script>
207</div>
208<div>
209<ul class="subNavList">
210<li>Summary:&nbsp;</li>
211<li>Required&nbsp;|&nbsp;</li>
212<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
213</ul>
214<ul class="subNavList">
215<li>Detail:&nbsp;</li>
216<li><a href="#annotation_type_element_detail">Element</a></li>
217</ul>
218</div>
219<a name="skip-navbar_bottom">
220<!--   -->
221</a></div>
222<!-- ======== END OF BOTTOM NAVBAR ======= -->
223<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
224</body>
225</html>
226