• Home
  • 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_55) on Thu Jan 01 15:31:15 PST 2015 -->
6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7<title>JsonPropertyDescription (Jackson-annotations 2.5.0 API)</title>
8<meta name="date" content="2015-01-01">
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="JsonPropertyDescription (Jackson-annotations 2.5.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/JsonPropertyDescription.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/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation 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/JsonPropertyDescription.html" target="_top">Frames</a></li>
44<li><a href="JsonPropertyDescription.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 JsonPropertyDescription" class="title">Annotation Type JsonPropertyDescription</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://download.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://download.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://download.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://download.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://download.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://download.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>})
88<a href="http://download.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://download.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://download.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">JsonPropertyDescription</span></pre>
90<div class="block">Annotaion used to define a human readable description for a logical
91 property.
92 Currently used to populate the description field in generated JSON
93 Schemas.</div>
94<dl><dt><span class="strong">Since:</span></dt>
95  <dd>2.3</dd></dl>
96</li>
97</ul>
98</div>
99<div class="summary">
100<ul class="blockList">
101<li class="blockList">
102<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
103<ul class="blockList">
104<li class="blockList"><a name="annotation_type_optional_element_summary">
105<!--   -->
106</a>
107<h3>Optional Element Summary</h3>
108<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
109<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
110<tr>
111<th class="colFirst" scope="col">Modifier and Type</th>
112<th class="colLast" scope="col">Optional Element and Description</th>
113</tr>
114<tr class="altColor">
115<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
116<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html#value()">value</a></strong></code>
117<div class="block">Defines a human readable description of the logical property.</div>
118</td>
119</tr>
120</table>
121</li>
122</ul>
123</li>
124</ul>
125</div>
126<div class="details">
127<ul class="blockList">
128<li class="blockList">
129<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
130<ul class="blockList">
131<li class="blockList"><a name="annotation_type_element_detail">
132<!--   -->
133</a>
134<h3>Element Detail</h3>
135<a name="value()">
136<!--   -->
137</a>
138<ul class="blockListLast">
139<li class="blockList">
140<h4>value</h4>
141<pre>public abstract&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value</pre>
142<div class="block">Defines a human readable description of the logical property.
143 Currently used to populate the description field in generated JSON
144 Schemas.</div>
145<dl>
146<dt>Default:</dt>
147<dd>""</dd>
148</dl>
149</li>
150</ul>
151</li>
152</ul>
153</li>
154</ul>
155</div>
156</div>
157<!-- ========= END OF CLASS DATA ========= -->
158<!-- ======= START OF BOTTOM NAVBAR ====== -->
159<div class="bottomNav"><a name="navbar_bottom">
160<!--   -->
161</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
162<!--   -->
163</a>
164<ul class="navList" title="Navigation">
165<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
166<li class="navBarCell1Rev">Class</li>
167<li><a href="class-use/JsonPropertyDescription.html">Use</a></li>
168<li><a href="package-tree.html">Tree</a></li>
169<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
170<li><a href="../../../../index-all.html">Index</a></li>
171<li><a href="../../../../help-doc.html">Help</a></li>
172</ul>
173</div>
174<div class="subNav">
175<ul class="navList">
176<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
177<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
178</ul>
179<ul class="navList">
180<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyDescription.html" target="_top">Frames</a></li>
181<li><a href="JsonPropertyDescription.html" target="_top">No Frames</a></li>
182</ul>
183<ul class="navList" id="allclasses_navbar_bottom">
184<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
185</ul>
186<div>
187<script type="text/javascript"><!--
188  allClassesLink = document.getElementById("allclasses_navbar_bottom");
189  if(window==top) {
190    allClassesLink.style.display = "block";
191  }
192  else {
193    allClassesLink.style.display = "none";
194  }
195  //-->
196</script>
197</div>
198<div>
199<ul class="subNavList">
200<li>Summary:&nbsp;</li>
201<li>Required&nbsp;|&nbsp;</li>
202<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
203</ul>
204<ul class="subNavList">
205<li>Detail:&nbsp;</li>
206<li><a href="#annotation_type_element_detail">Element</a></li>
207</ul>
208</div>
209<a name="skip-navbar_bottom">
210<!--   -->
211</a></div>
212<!-- ======== END OF BOTTOM NAVBAR ======= -->
213<p class="legalCopy"><small>Copyright &#169; 2014-2015 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p>
214</body>
215</html>
216