• 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_10-ea) on Mon Apr 22 19:50:30 PDT 2013 -->
6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7<title>BeanProperty.Std (jackson-databind 2.2.0 API)</title>
8<meta name="date" content="2013-04-22">
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="BeanProperty.Std (jackson-databind 2.2.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="../../../../overview-summary.html">Overview</a></li>
29<li><a href="package-summary.html">Package</a></li>
30<li class="navBarCell1Rev">Class</li>
31<li><a href="class-use/BeanProperty.Std.html">Use</a></li>
32<li><a href="package-tree.html">Tree</a></li>
33<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
34<li><a href="../../../../index-all.html">Index</a></li>
35<li><a href="../../../../help-doc.html">Help</a></li>
36</ul>
37</div>
38<div class="subNav">
39<ul class="navList">
40<li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li>
41<li><a href="../../../../com/fasterxml/jackson/databind/DatabindContext.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li>
42</ul>
43<ul class="navList">
44<li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.Std.html" target="_top">Frames</a></li>
45<li><a href="BeanProperty.Std.html" target="_top">No Frames</a></li>
46</ul>
47<ul class="navList" id="allclasses_navbar_top">
48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
49</ul>
50<div>
51<script type="text/javascript"><!--
52  allClassesLink = document.getElementById("allclasses_navbar_top");
53  if(window==top) {
54    allClassesLink.style.display = "block";
55  }
56  else {
57    allClassesLink.style.display = "none";
58  }
59  //-->
60</script>
61</div>
62<div>
63<ul class="subNavList">
64<li>Summary:&nbsp;</li>
65<li>Nested&nbsp;|&nbsp;</li>
66<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
67<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
68<li><a href="#method_summary">Method</a></li>
69</ul>
70<ul class="subNavList">
71<li>Detail:&nbsp;</li>
72<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
73<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
74<li><a href="#method_detail">Method</a></li>
75</ul>
76</div>
77<a name="skip-navbar_top">
78<!--   -->
79</a></div>
80<!-- ========= END OF TOP NAVBAR ========= -->
81<!-- ======== START OF CLASS DATA ======== -->
82<div class="header">
83<div class="subTitle">com.fasterxml.jackson.databind</div>
84<h2 title="Class BeanProperty.Std" class="title">Class BeanProperty.Std</h2>
85</div>
86<div class="contentContainer">
87<ul class="inheritance">
88<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
89<li>
90<ul class="inheritance">
91<li>com.fasterxml.jackson.databind.BeanProperty.Std</li>
92</ul>
93</li>
94</ul>
95<div class="description">
96<ul class="blockList">
97<li class="blockList">
98<dl>
99<dt>All Implemented Interfaces:</dt>
100<dd><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></dd>
101</dl>
102<dl>
103<dt>Direct Known Subclasses:</dt>
104<dd><a href="../../../../com/fasterxml/jackson/databind/deser/impl/ValueInjector.html" title="class in com.fasterxml.jackson.databind.deser.impl">ValueInjector</a></dd>
105</dl>
106<dl>
107<dt>Enclosing interface:</dt>
108<dd><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></dd>
109</dl>
110<hr>
111<br>
112<pre>public static class <span class="strong">BeanProperty.Std</span>
113extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
114implements <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></pre>
115<div class="block">Simple stand-alone implementation, useful as a placeholder
116 or base class for more complex implementations.</div>
117</li>
118</ul>
119</div>
120<div class="summary">
121<ul class="blockList">
122<li class="blockList">
123<!-- ======== NESTED CLASS SUMMARY ======== -->
124<ul class="blockList">
125<li class="blockList"><a name="nested_class_summary">
126<!--   -->
127</a>
128<h3>Nested Class Summary</h3>
129<ul class="blockList">
130<li class="blockList"><a name="nested_classes_inherited_from_class_com.fasterxml.jackson.databind.BeanProperty">
131<!--   -->
132</a>
133<h3>Nested classes/interfaces inherited from interface&nbsp;com.fasterxml.jackson.databind.<a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></h3>
134<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></code></li>
135</ul>
136</li>
137</ul>
138<!-- =========== FIELD SUMMARY =========== -->
139<ul class="blockList">
140<li class="blockList"><a name="field_summary">
141<!--   -->
142</a>
143<h3>Field Summary</h3>
144<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
145<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
146<tr>
147<th class="colFirst" scope="col">Modifier and Type</th>
148<th class="colLast" scope="col">Field and Description</th>
149</tr>
150<tr class="altColor">
151<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a></code></td>
152<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_contextAnnotations">_contextAnnotations</a></strong></code>
153<div class="block">Annotations defined in the context class (if any); may be null
154 if no annotations were found</div>
155</td>
156</tr>
157<tr class="rowColor">
158<td class="colFirst"><code>protected boolean</code></td>
159<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_isRequired">_isRequired</a></strong></code>&nbsp;</td>
160</tr>
161<tr class="altColor">
162<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a></code></td>
163<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_member">_member</a></strong></code>
164<div class="block">Physical entity (field, method or constructor argument) that
165 is used to access value of property (or in case of constructor
166 property, just placeholder)</div>
167</td>
168</tr>
169<tr class="rowColor">
170<td class="colFirst"><code>protected <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></td>
171<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_name">_name</a></strong></code>&nbsp;</td>
172</tr>
173<tr class="altColor">
174<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td>
175<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_type">_type</a></strong></code>&nbsp;</td>
176</tr>
177<tr class="rowColor">
178<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td>
179<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_wrapperName">_wrapperName</a></strong></code>&nbsp;</td>
180</tr>
181</table>
182</li>
183</ul>
184<!-- ======== CONSTRUCTOR SUMMARY ======== -->
185<ul class="blockList">
186<li class="blockList"><a name="constructor_summary">
187<!--   -->
188</a>
189<h3>Constructor Summary</h3>
190<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
191<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
192<tr>
193<th class="colOne" scope="col">Constructor and Description</th>
194</tr>
195<tr class="altColor">
196<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#BeanProperty.Std(java.lang.String, com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.util.Annotations, com.fasterxml.jackson.databind.introspect.AnnotatedMember, boolean)">BeanProperty.Std</a></strong>(<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>&nbsp;name,
197                <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a>&nbsp;type,
198                <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a>&nbsp;wrapperName,
199                <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a>&nbsp;contextAnnotations,
200                <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a>&nbsp;member,
201                boolean&nbsp;isRequired)</code>&nbsp;</td>
202</tr>
203</table>
204</li>
205</ul>
206<!-- ========== METHOD SUMMARY =========== -->
207<ul class="blockList">
208<li class="blockList"><a name="method_summary">
209<!--   -->
210</a>
211<h3>Method Summary</h3>
212<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
213<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
214<tr>
215<th class="colFirst" scope="col">Modifier and Type</th>
216<th class="colLast" scope="col">Method and Description</th>
217</tr>
218<tr class="altColor">
219<td class="colFirst"><code>void</code></td>
220<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)">depositSchemaProperty</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a>&nbsp;objectVisitor)</code>
221<div class="block">Implementation of this method throws
222 <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>, since instances of this
223 implementation should not be used as part of actual structure
224 visited.</div>
225</td>
226</tr>
227<tr class="rowColor">
228<td class="colFirst"><code>&lt;A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;<br>A</code></td>
229<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getAnnotation(java.lang.Class)">getAnnotation</a></strong>(<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;A&gt;&nbsp;acls)</code>
230<div class="block">Method for finding annotation associated with this property;
231 meaning annotation associated with one of entities used to
232 access property.</div>
233</td>
234</tr>
235<tr class="altColor">
236<td class="colFirst"><code>&lt;A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;<br>A</code></td>
237<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getContextAnnotation(java.lang.Class)">getContextAnnotation</a></strong>(<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;A&gt;&nbsp;acls)</code>
238<div class="block">Method for finding annotation associated with context of
239 this property; usually class in which member is declared
240 (or its subtype if processing subtype).</div>
241</td>
242</tr>
243<tr class="rowColor">
244<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a></code></td>
245<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getMember()">getMember</a></strong>()</code>
246<div class="block">Method for accessing primary physical entity that represents the property;
247 annotated field, method or constructor property.</div>
248</td>
249</tr>
250<tr class="altColor">
251<td class="colFirst"><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></td>
252<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getName()">getName</a></strong>()</code>
253<div class="block">Method to get logical name of the property</div>
254</td>
255</tr>
256<tr class="rowColor">
257<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td>
258<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getType()">getType</a></strong>()</code>
259<div class="block">Method to get declared type of the property.</div>
260</td>
261</tr>
262<tr class="altColor">
263<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td>
264<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getWrapperName()">getWrapperName</a></strong>()</code>
265<div class="block">If property is indicated to be wrapped, name of
266 wrapper element to use.</div>
267</td>
268</tr>
269<tr class="rowColor">
270<td class="colFirst"><code>boolean</code></td>
271<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#isRequired()">isRequired</a></strong>()</code>
272<div class="block">Whether value for property is marked as required using
273 annotations or associated schema.</div>
274</td>
275</tr>
276<tr class="altColor">
277<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></code></td>
278<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#withType(com.fasterxml.jackson.databind.JavaType)">withType</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a>&nbsp;type)</code>&nbsp;</td>
279</tr>
280</table>
281<ul class="blockList">
282<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
283<!--   -->
284</a>
285<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
286<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
287</ul>
288</li>
289</ul>
290</li>
291</ul>
292</div>
293<div class="details">
294<ul class="blockList">
295<li class="blockList">
296<!-- ============ FIELD DETAIL =========== -->
297<ul class="blockList">
298<li class="blockList"><a name="field_detail">
299<!--   -->
300</a>
301<h3>Field Detail</h3>
302<a name="_name">
303<!--   -->
304</a>
305<ul class="blockList">
306<li class="blockList">
307<h4>_name</h4>
308<pre>protected final&nbsp;<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> _name</pre>
309</li>
310</ul>
311<a name="_type">
312<!--   -->
313</a>
314<ul class="blockList">
315<li class="blockList">
316<h4>_type</h4>
317<pre>protected final&nbsp;<a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> _type</pre>
318</li>
319</ul>
320<a name="_wrapperName">
321<!--   -->
322</a>
323<ul class="blockList">
324<li class="blockList">
325<h4>_wrapperName</h4>
326<pre>protected final&nbsp;<a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> _wrapperName</pre>
327</li>
328</ul>
329<a name="_isRequired">
330<!--   -->
331</a>
332<ul class="blockList">
333<li class="blockList">
334<h4>_isRequired</h4>
335<pre>protected final&nbsp;boolean _isRequired</pre>
336</li>
337</ul>
338<a name="_member">
339<!--   -->
340</a>
341<ul class="blockList">
342<li class="blockList">
343<h4>_member</h4>
344<pre>protected final&nbsp;<a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> _member</pre>
345<div class="block">Physical entity (field, method or constructor argument) that
346 is used to access value of property (or in case of constructor
347 property, just placeholder)</div>
348</li>
349</ul>
350<a name="_contextAnnotations">
351<!--   -->
352</a>
353<ul class="blockListLast">
354<li class="blockList">
355<h4>_contextAnnotations</h4>
356<pre>protected final&nbsp;<a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a> _contextAnnotations</pre>
357<div class="block">Annotations defined in the context class (if any); may be null
358 if no annotations were found</div>
359</li>
360</ul>
361</li>
362</ul>
363<!-- ========= CONSTRUCTOR DETAIL ======== -->
364<ul class="blockList">
365<li class="blockList"><a name="constructor_detail">
366<!--   -->
367</a>
368<h3>Constructor Detail</h3>
369<a name="BeanProperty.Std(java.lang.String, com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.util.Annotations, com.fasterxml.jackson.databind.introspect.AnnotatedMember, boolean)">
370<!--   -->
371</a>
372<ul class="blockListLast">
373<li class="blockList">
374<h4>BeanProperty.Std</h4>
375<pre>public&nbsp;BeanProperty.Std(<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>&nbsp;name,
376                <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a>&nbsp;type,
377                <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a>&nbsp;wrapperName,
378                <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a>&nbsp;contextAnnotations,
379                <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a>&nbsp;member,
380                boolean&nbsp;isRequired)</pre>
381</li>
382</ul>
383</li>
384</ul>
385<!-- ============ METHOD DETAIL ========== -->
386<ul class="blockList">
387<li class="blockList"><a name="method_detail">
388<!--   -->
389</a>
390<h3>Method Detail</h3>
391<a name="withType(com.fasterxml.jackson.databind.JavaType)">
392<!--   -->
393</a>
394<ul class="blockList">
395<li class="blockList">
396<h4>withType</h4>
397<pre>public&nbsp;<a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a>&nbsp;withType(<a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a>&nbsp;type)</pre>
398</li>
399</ul>
400<a name="getAnnotation(java.lang.Class)">
401<!--   -->
402</a>
403<ul class="blockList">
404<li class="blockList">
405<h4>getAnnotation</h4>
406<pre>public&nbsp;&lt;A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;A&nbsp;getAnnotation(<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;A&gt;&nbsp;acls)</pre>
407<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation(java.lang.Class)">BeanProperty</a></code></strong></div>
408<div class="block">Method for finding annotation associated with this property;
409 meaning annotation associated with one of entities used to
410 access property.</div>
411<dl>
412<dt><strong>Specified by:</strong></dt>
413<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation(java.lang.Class)">getAnnotation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
414</dl>
415</li>
416</ul>
417<a name="getContextAnnotation(java.lang.Class)">
418<!--   -->
419</a>
420<ul class="blockList">
421<li class="blockList">
422<h4>getContextAnnotation</h4>
423<pre>public&nbsp;&lt;A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;&nbsp;A&nbsp;getContextAnnotation(<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;A&gt;&nbsp;acls)</pre>
424<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation(java.lang.Class)">BeanProperty</a></code></strong></div>
425<div class="block">Method for finding annotation associated with context of
426 this property; usually class in which member is declared
427 (or its subtype if processing subtype).</div>
428<dl>
429<dt><strong>Specified by:</strong></dt>
430<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation(java.lang.Class)">getContextAnnotation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
431</dl>
432</li>
433</ul>
434<a name="getName()">
435<!--   -->
436</a>
437<ul class="blockList">
438<li class="blockList">
439<h4>getName</h4>
440<pre>public&nbsp;<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>&nbsp;getName()</pre>
441<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">BeanProperty</a></code></strong></div>
442<div class="block">Method to get logical name of the property</div>
443<dl>
444<dt><strong>Specified by:</strong></dt>
445<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
446<dt><strong>Specified by:</strong></dt>
447<dd><code><a href="../../../../com/fasterxml/jackson/databind/util/Named.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></code></dd>
448</dl>
449</li>
450</ul>
451<a name="getType()">
452<!--   -->
453</a>
454<ul class="blockList">
455<li class="blockList">
456<h4>getType</h4>
457<pre>public&nbsp;<a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a>&nbsp;getType()</pre>
458<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">BeanProperty</a></code></strong></div>
459<div class="block">Method to get declared type of the property.</div>
460<dl>
461<dt><strong>Specified by:</strong></dt>
462<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
463</dl>
464</li>
465</ul>
466<a name="getWrapperName()">
467<!--   -->
468</a>
469<ul class="blockList">
470<li class="blockList">
471<h4>getWrapperName</h4>
472<pre>public&nbsp;<a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a>&nbsp;getWrapperName()</pre>
473<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName()">BeanProperty</a></code></strong></div>
474<div class="block">If property is indicated to be wrapped, name of
475 wrapper element to use.</div>
476<dl>
477<dt><strong>Specified by:</strong></dt>
478<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName()">getWrapperName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
479</dl>
480</li>
481</ul>
482<a name="isRequired()">
483<!--   -->
484</a>
485<ul class="blockList">
486<li class="blockList">
487<h4>isRequired</h4>
488<pre>public&nbsp;boolean&nbsp;isRequired()</pre>
489<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isRequired()">BeanProperty</a></code></strong></div>
490<div class="block">Whether value for property is marked as required using
491 annotations or associated schema.</div>
492<dl>
493<dt><strong>Specified by:</strong></dt>
494<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isRequired()">isRequired</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
495</dl>
496</li>
497</ul>
498<a name="getMember()">
499<!--   -->
500</a>
501<ul class="blockList">
502<li class="blockList">
503<h4>getMember</h4>
504<pre>public&nbsp;<a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a>&nbsp;getMember()</pre>
505<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">BeanProperty</a></code></strong></div>
506<div class="block">Method for accessing primary physical entity that represents the property;
507 annotated field, method or constructor property.</div>
508<dl>
509<dt><strong>Specified by:</strong></dt>
510<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">getMember</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
511</dl>
512</li>
513</ul>
514<a name="depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)">
515<!--   -->
516</a>
517<ul class="blockListLast">
518<li class="blockList">
519<h4>depositSchemaProperty</h4>
520<pre>public&nbsp;void&nbsp;depositSchemaProperty(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a>&nbsp;objectVisitor)</pre>
521<div class="block">Implementation of this method throws
522 <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>, since instances of this
523 implementation should not be used as part of actual structure
524 visited. Rather, other implementations should handle it.</div>
525<dl>
526<dt><strong>Specified by:</strong></dt>
527<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)">depositSchemaProperty</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd>
528<dt><span class="strong">Parameters:</span></dt><dd><code>objectVisitor</code> - Visitor to used as the callback handler</dd></dl>
529</li>
530</ul>
531</li>
532</ul>
533</li>
534</ul>
535</div>
536</div>
537<!-- ========= END OF CLASS DATA ========= -->
538<!-- ======= START OF BOTTOM NAVBAR ====== -->
539<div class="bottomNav"><a name="navbar_bottom">
540<!--   -->
541</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
542<!--   -->
543</a>
544<ul class="navList" title="Navigation">
545<li><a href="../../../../overview-summary.html">Overview</a></li>
546<li><a href="package-summary.html">Package</a></li>
547<li class="navBarCell1Rev">Class</li>
548<li><a href="class-use/BeanProperty.Std.html">Use</a></li>
549<li><a href="package-tree.html">Tree</a></li>
550<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
551<li><a href="../../../../index-all.html">Index</a></li>
552<li><a href="../../../../help-doc.html">Help</a></li>
553</ul>
554</div>
555<div class="subNav">
556<ul class="navList">
557<li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li>
558<li><a href="../../../../com/fasterxml/jackson/databind/DatabindContext.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li>
559</ul>
560<ul class="navList">
561<li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.Std.html" target="_top">Frames</a></li>
562<li><a href="BeanProperty.Std.html" target="_top">No Frames</a></li>
563</ul>
564<ul class="navList" id="allclasses_navbar_bottom">
565<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
566</ul>
567<div>
568<script type="text/javascript"><!--
569  allClassesLink = document.getElementById("allclasses_navbar_bottom");
570  if(window==top) {
571    allClassesLink.style.display = "block";
572  }
573  else {
574    allClassesLink.style.display = "none";
575  }
576  //-->
577</script>
578</div>
579<div>
580<ul class="subNavList">
581<li>Summary:&nbsp;</li>
582<li>Nested&nbsp;|&nbsp;</li>
583<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
584<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
585<li><a href="#method_summary">Method</a></li>
586</ul>
587<ul class="subNavList">
588<li>Detail:&nbsp;</li>
589<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
590<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
591<li><a href="#method_detail">Method</a></li>
592</ul>
593</div>
594<a name="skip-navbar_bottom">
595<!--   -->
596</a></div>
597<!-- ======== END OF BOTTOM NAVBAR ======= -->
598<p class="legalCopy"><small>Copyright &#169; 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p>
599</body>
600</html>
601