• 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_10-ea) on Sun Jul 14 20:03:25 PDT 2013 -->
6<title>BeanProperty (Jackson JSON Processor)</title>
7<meta name="date" content="2013-07-14">
8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="BeanProperty (Jackson JSON Processor)";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/BeanProperty.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="../../../../org/codehaus/jackson/map/BeanDescription.html" title="class in org.codehaus.jackson.map"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../org/codehaus/jackson/map/BeanProperty.Std.html" title="class in org.codehaus.jackson.map"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?org/codehaus/jackson/map/BeanProperty.html" target="_top">Frames</a></li>
44<li><a href="BeanProperty.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li>Constr&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li>Constr&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">org.codehaus.jackson.map</div>
83<h2 title="Interface BeanProperty" class="title">Interface BeanProperty</h2>
84</div>
85<div class="contentContainer">
86<div class="description">
87<ul class="blockList">
88<li class="blockList">
89<dl>
90<dt>All Superinterfaces:</dt>
91<dd><a href="../../../../org/codehaus/jackson/map/util/Named.html" title="interface in org.codehaus.jackson.map.util">Named</a></dd>
92</dl>
93<dl>
94<dt>All Known Implementing Classes:</dt>
95<dd><a href="../../../../org/codehaus/jackson/map/BeanProperty.Std.html" title="class in org.codehaus.jackson.map">BeanProperty.Std</a>, <a href="../../../../org/codehaus/jackson/map/ser/BeanPropertyWriter.html" title="class in org.codehaus.jackson.map.ser">BeanPropertyWriter</a>, <a href="../../../../org/codehaus/jackson/map/deser/impl/CreatorProperty.html" title="class in org.codehaus.jackson.map.deser.impl">CreatorProperty</a>, <a href="../../../../org/codehaus/jackson/map/deser/SettableBeanProperty.html" title="class in org.codehaus.jackson.map.deser">SettableBeanProperty</a>, <a href="../../../../org/codehaus/jackson/map/deser/SettableBeanProperty.FieldProperty.html" title="class in org.codehaus.jackson.map.deser">SettableBeanProperty.FieldProperty</a>, <a href="../../../../org/codehaus/jackson/map/deser/SettableBeanProperty.InnerClassProperty.html" title="class in org.codehaus.jackson.map.deser">SettableBeanProperty.InnerClassProperty</a>, <a href="../../../../org/codehaus/jackson/map/deser/SettableBeanProperty.ManagedReferenceProperty.html" title="class in org.codehaus.jackson.map.deser">SettableBeanProperty.ManagedReferenceProperty</a>, <a href="../../../../org/codehaus/jackson/map/deser/SettableBeanProperty.MethodProperty.html" title="class in org.codehaus.jackson.map.deser">SettableBeanProperty.MethodProperty</a>, <a href="../../../../org/codehaus/jackson/map/deser/SettableBeanProperty.SetterlessProperty.html" title="class in org.codehaus.jackson.map.deser">SettableBeanProperty.SetterlessProperty</a>, <a href="../../../../org/codehaus/jackson/map/ser/impl/UnwrappingBeanPropertyWriter.html" title="class in org.codehaus.jackson.map.ser.impl">UnwrappingBeanPropertyWriter</a>, <a href="../../../../org/codehaus/jackson/map/deser/impl/ValueInjector.html" title="class in org.codehaus.jackson.map.deser.impl">ValueInjector</a></dd>
96</dl>
97<hr>
98<br>
99<pre>public interface <span class="strong">BeanProperty</span>
100extends <a href="../../../../org/codehaus/jackson/map/util/Named.html" title="interface in org.codehaus.jackson.map.util">Named</a></pre>
101<div class="block">Bean properties are logical entities that represent data
102 Java objects ("beans", although more accurately POJOs)
103 contain; and that are accessed using some combination
104 of methods (getter, setter), field and constructor
105 parameter.
106 Instances allow access to annotations directly associated
107 to property (via field or method), as well as contextual
108 annotations (annotations for class that contains properties).
109<p>
110 Instances are passed during construction of serializers and
111 deserializers, and references can be stored by serializers
112 and deserializers for futher use; mostly to retain access
113 to annotations when dynamically locating handlers for
114 sub-properties or dynamic types.</div>
115<dl><dt><span class="strong">Since:</span></dt>
116  <dd>1.7</dd></dl>
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<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
130<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
131<tr>
132<th class="colFirst" scope="col">Modifier and Type</th>
133<th class="colLast" scope="col">Interface and Description</th>
134</tr>
135<tr class="altColor">
136<td class="colFirst"><code>static class&nbsp;</code></td>
137<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/BeanProperty.Std.html" title="class in org.codehaus.jackson.map">BeanProperty.Std</a></strong></code>&nbsp;</td>
138</tr>
139</table>
140</li>
141</ul>
142<!-- ========== METHOD SUMMARY =========== -->
143<ul class="blockList">
144<li class="blockList"><a name="method_summary">
145<!--   -->
146</a>
147<h3>Method Summary</h3>
148<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
149<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
150<tr>
151<th class="colFirst" scope="col">Modifier and Type</th>
152<th class="colLast" scope="col">Method and Description</th>
153</tr>
154<tr class="altColor">
155<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>
156<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/BeanProperty.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>
157<div class="block">Method for finding annotation associated with this property;
158 meaning annotation associated with one of entities used to
159 access property.</div>
160</td>
161</tr>
162<tr class="rowColor">
163<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>
164<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/BeanProperty.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>
165<div class="block">Method for finding annotation associated with context of
166 this property; usually class in which member is declared
167 (or its subtype if processing subtype).</div>
168</td>
169</tr>
170<tr class="altColor">
171<td class="colFirst"><code><a href="../../../../org/codehaus/jackson/map/introspect/AnnotatedMember.html" title="class in org.codehaus.jackson.map.introspect">AnnotatedMember</a></code></td>
172<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/BeanProperty.html#getMember()">getMember</a></strong>()</code>
173<div class="block">Method for accessing primary physical entity that represents the property;
174 annotated field, method or constructor property.</div>
175</td>
176</tr>
177<tr class="rowColor">
178<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>
179<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/BeanProperty.html#getName()">getName</a></strong>()</code>
180<div class="block">Method to get logical name of the property</div>
181</td>
182</tr>
183<tr class="altColor">
184<td class="colFirst"><code><a href="../../../../org/codehaus/jackson/type/JavaType.html" title="class in org.codehaus.jackson.type">JavaType</a></code></td>
185<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/BeanProperty.html#getType()">getType</a></strong>()</code>
186<div class="block">Method to get declared type of the property.</div>
187</td>
188</tr>
189</table>
190</li>
191</ul>
192</li>
193</ul>
194</div>
195<div class="details">
196<ul class="blockList">
197<li class="blockList">
198<!-- ============ METHOD DETAIL ========== -->
199<ul class="blockList">
200<li class="blockList"><a name="method_detail">
201<!--   -->
202</a>
203<h3>Method Detail</h3>
204<a name="getName()">
205<!--   -->
206</a>
207<ul class="blockList">
208<li class="blockList">
209<h4>getName</h4>
210<pre><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>
211<div class="block">Method to get logical name of the property</div>
212<dl>
213<dt><strong>Specified by:</strong></dt>
214<dd><code><a href="../../../../org/codehaus/jackson/map/util/Named.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/codehaus/jackson/map/util/Named.html" title="interface in org.codehaus.jackson.map.util">Named</a></code></dd>
215</dl>
216</li>
217</ul>
218<a name="getType()">
219<!--   -->
220</a>
221<ul class="blockList">
222<li class="blockList">
223<h4>getType</h4>
224<pre><a href="../../../../org/codehaus/jackson/type/JavaType.html" title="class in org.codehaus.jackson.type">JavaType</a>&nbsp;getType()</pre>
225<div class="block">Method to get declared type of the property.</div>
226</li>
227</ul>
228<a name="getAnnotation(java.lang.Class)">
229<!--   -->
230</a>
231<ul class="blockList">
232<li class="blockList">
233<h4>getAnnotation</h4>
234<pre>&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>
235<div class="block">Method for finding annotation associated with this property;
236 meaning annotation associated with one of entities used to
237 access property.</div>
238</li>
239</ul>
240<a name="getContextAnnotation(java.lang.Class)">
241<!--   -->
242</a>
243<ul class="blockList">
244<li class="blockList">
245<h4>getContextAnnotation</h4>
246<pre>&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>
247<div class="block">Method for finding annotation associated with context of
248 this property; usually class in which member is declared
249 (or its subtype if processing subtype).</div>
250</li>
251</ul>
252<a name="getMember()">
253<!--   -->
254</a>
255<ul class="blockListLast">
256<li class="blockList">
257<h4>getMember</h4>
258<pre><a href="../../../../org/codehaus/jackson/map/introspect/AnnotatedMember.html" title="class in org.codehaus.jackson.map.introspect">AnnotatedMember</a>&nbsp;getMember()</pre>
259<div class="block">Method for accessing primary physical entity that represents the property;
260 annotated field, method or constructor property.</div>
261</li>
262</ul>
263</li>
264</ul>
265</li>
266</ul>
267</div>
268</div>
269<!-- ========= END OF CLASS DATA ========= -->
270<!-- ======= START OF BOTTOM NAVBAR ====== -->
271<div class="bottomNav"><a name="navbar_bottom">
272<!--   -->
273</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
274<!--   -->
275</a>
276<ul class="navList" title="Navigation">
277<li><a href="../../../../overview-summary.html">Overview</a></li>
278<li><a href="package-summary.html">Package</a></li>
279<li class="navBarCell1Rev">Class</li>
280<li><a href="class-use/BeanProperty.html">Use</a></li>
281<li><a href="package-tree.html">Tree</a></li>
282<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
283<li><a href="../../../../index-all.html">Index</a></li>
284<li><a href="../../../../help-doc.html">Help</a></li>
285</ul>
286</div>
287<div class="subNav">
288<ul class="navList">
289<li><a href="../../../../org/codehaus/jackson/map/BeanDescription.html" title="class in org.codehaus.jackson.map"><span class="strong">Prev Class</span></a></li>
290<li><a href="../../../../org/codehaus/jackson/map/BeanProperty.Std.html" title="class in org.codehaus.jackson.map"><span class="strong">Next Class</span></a></li>
291</ul>
292<ul class="navList">
293<li><a href="../../../../index.html?org/codehaus/jackson/map/BeanProperty.html" target="_top">Frames</a></li>
294<li><a href="BeanProperty.html" target="_top">No Frames</a></li>
295</ul>
296<ul class="navList" id="allclasses_navbar_bottom">
297<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
298</ul>
299<div>
300<script type="text/javascript"><!--
301  allClassesLink = document.getElementById("allclasses_navbar_bottom");
302  if(window==top) {
303    allClassesLink.style.display = "block";
304  }
305  else {
306    allClassesLink.style.display = "none";
307  }
308  //-->
309</script>
310</div>
311<div>
312<ul class="subNavList">
313<li>Summary:&nbsp;</li>
314<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
315<li>Field&nbsp;|&nbsp;</li>
316<li>Constr&nbsp;|&nbsp;</li>
317<li><a href="#method_summary">Method</a></li>
318</ul>
319<ul class="subNavList">
320<li>Detail:&nbsp;</li>
321<li>Field&nbsp;|&nbsp;</li>
322<li>Constr&nbsp;|&nbsp;</li>
323<li><a href="#method_detail">Method</a></li>
324</ul>
325</div>
326<a name="skip-navbar_bottom">
327<!--   -->
328</a></div>
329<!-- ======== END OF BOTTOM NAVBAR ======= -->
330</body>
331</html>
332