• 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>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_29) on Mon Mar 26 19:07:15 PDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<TITLE>
8BeanPropertyDefinition (jackson-databind 2.0.0 API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-03-26">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="BeanPropertyDefinition (jackson-databind 2.0.0 API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BeanPropertyDefinition.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
48  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
49  </TR>
50</TABLE>
51</TD>
52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53</EM>
54</TD>
55</TR>
56
57<TR>
58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BasicClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><B>PREV CLASS</B></A>&nbsp;
60&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><B>NEXT CLASS</B></A></FONT></TD>
61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62  <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" target="_top"><B>FRAMES</B></A>  &nbsp;
63&nbsp;<A HREF="BeanPropertyDefinition.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
64&nbsp;<SCRIPT type="text/javascript">
65  <!--
66  if(window==top) {
67    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68  }
69  //-->
70</SCRIPT>
71<NOSCRIPT>
72  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
73</NOSCRIPT>
74
75
76</FONT></TD>
77</TR>
78<TR>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
83</TR>
84</TABLE>
85<A NAME="skip-navbar_top"></A>
86<!-- ========= END OF TOP NAVBAR ========= -->
87
88<HR>
89<!-- ======== START OF CLASS DATA ======== -->
90<H2>
91<FONT SIZE="-1">
92com.fasterxml.jackson.databind.introspect</FONT>
93<BR>
94Class BeanPropertyDefinition</H2>
95<PRE>
96<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>
97  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><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><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/POJOPropertyBuilder.html" title="class in com.fasterxml.jackson.databind.introspect">POJOPropertyBuilder</A>, <A HREF="../../../../../com/fasterxml/jackson/databind/util/SimpleBeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.util">SimpleBeanPropertyDefinition</A></DD>
104</DL>
105<HR>
106<DL>
107<DT><PRE>public abstract class <B>BeanPropertyDefinition</B><DT>extends <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><DT>implements <A HREF="../../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</A></DL>
108</PRE>
109
110<P>
111Simple value classes that contain definitions of properties,
112 used during introspection of properties to use for
113 serialization and deserialization purposes.
114 These instances are created before actual <A HREF="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><CODE>BeanProperty</CODE></A>
115 instances are created, i.e. they are used earlier in the process
116 flow, and are typically use to construct actual
117 <A HREF="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><CODE>BeanProperty</CODE></A> instances.
118<P>
119
120<P>
121<HR>
122
123<P>
124
125<!-- ======== CONSTRUCTOR SUMMARY ======== -->
126
127<A NAME="constructor_summary"><!-- --></A>
128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
131<B>Constructor Summary</B></FONT></TH>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#BeanPropertyDefinition()">BeanPropertyDefinition</A></B>()</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138</TR>
139</TABLE>
140&nbsp;
141<!-- ========== METHOD SUMMARY =========== -->
142
143<A NAME="method_summary"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147<B>Method Summary</B></FONT></TH>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;boolean</CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#couldDeserialize()">couldDeserialize</A></B>()</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;boolean</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#couldSerialize()">couldSerialize</A></B>()</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<CODE>&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ObjectIdInfo.html" title="class in com.fasterxml.jackson.databind.introspect">ObjectIdInfo</A></CODE></FONT></TD>
168<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findObjectIdInfo()">findObjectIdInfo</A></B>()</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method used to check whether this logical property indicates that
172 value POJOs should be written using additional Object Identifier
173 (or, when multiple references exist, all but first AS Object Identifier).</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</A></CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findReferenceType()">findReferenceType</A></B>()</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method used to find whether property is part of a bi-directional
182 reference.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&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;[]</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findViews()">findViews</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method used to find View-inclusion definitions for the property.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>abstract &nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A></CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getAccessor()">getAccessor</A></B>()</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method used to find accessor (getter, field to access) to use for accessing
199 value of the property.</TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203<CODE>abstract &nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</A></CODE></FONT></TD>
204<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getConstructorParameter()">getConstructorParameter</A></B>()</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<CODE>abstract &nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedField.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedField</A></CODE></FONT></TD>
212<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getField()">getField</A></B>()</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219<CODE>abstract &nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A></CODE></FONT></TD>
220<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getGetter()">getGetter</A></B>()</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>abstract &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></CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getInternalName()">getInternalName</A></B>()</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Accessor that can be used to determine implicit name from underlying
232 element(s) before possible renaming.</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>abstract &nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A></CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getMutator()">getMutator</A></B>()</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method used to find mutator (constructor parameter, setter, field) to use for
241 changing value of the property.</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>abstract &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></CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()">getName</A></B>()</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Accessor for name used for external representation (in JSON).</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>abstract &nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A></CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getSetter()">getSetter</A></B>()</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasConstructorParameter()">hasConstructorParameter</A></B>()</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasField()">hasField</A></B>()</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
274</TR>
275<TR BGCOLOR="white" CLASS="TableRowColor">
276<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
278<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasGetter()">hasGetter</A></B>()</CODE>
279
280<BR>
281&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
282</TR>
283<TR BGCOLOR="white" CLASS="TableRowColor">
284<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
286<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasSetter()">hasSetter</A></B>()</CODE>
287
288<BR>
289&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
290</TR>
291<TR BGCOLOR="white" CLASS="TableRowColor">
292<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
294<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isExplicitlyIncluded()">isExplicitlyIncluded</A></B>()</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Accessor that can be called to check whether property was included
298 due to an explicit marker (usually annotation), or just by naming
299 convention.</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>&nbsp;boolean</CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isRequired()">isRequired</A></B>()</CODE>
305
306<BR>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method used to check if this property is expected to have a value;
308 and if none found, should either be considered invalid (and most likely
309 fail deserialization), or handled by other means (by providing default
310 value)</TD>
311</TR>
312<TR BGCOLOR="white" CLASS="TableRowColor">
313<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
314<CODE>&nbsp;boolean</CODE></FONT></TD>
315<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isTypeId()">isTypeId</A></B>()</CODE>
316
317<BR>
318&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method used to check whether this logical property has a marker
319 to indicate it should be used as the type id for polymorphic type
320 handling.</TD>
321</TR>
322<TR BGCOLOR="white" CLASS="TableRowColor">
323<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
324<CODE>abstract &nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</A></CODE></FONT></TD>
325<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#withName(java.lang.String)">withName</A></B>(<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;newName)</CODE>
326
327<BR>
328&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method that can be used to create a definition with
329 same settings as this one, but with different
330 (external) name; that is, one for which
331 <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()"><CODE>getName()</CODE></A> would return <code>newName</code>.</TD>
332</TR>
333</TABLE>
334&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
335<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
336<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
337<TH ALIGN="left"><B>Methods inherited from class 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></B></TH>
338</TR>
339<TR BGCOLOR="white" CLASS="TableRowColor">
340<TD><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></TD>
341</TR>
342</TABLE>
343&nbsp;
344<P>
345
346<!-- ========= CONSTRUCTOR DETAIL ======== -->
347
348<A NAME="constructor_detail"><!-- --></A>
349<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
350<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
351<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
352<B>Constructor Detail</B></FONT></TH>
353</TR>
354</TABLE>
355
356<A NAME="BeanPropertyDefinition()"><!-- --></A><H3>
357BeanPropertyDefinition</H3>
358<PRE>
359public <B>BeanPropertyDefinition</B>()</PRE>
360<DL>
361</DL>
362
363<!-- ============ METHOD DETAIL ========== -->
364
365<A NAME="method_detail"><!-- --></A>
366<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
367<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
368<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
369<B>Method Detail</B></FONT></TH>
370</TR>
371</TABLE>
372
373<A NAME="withName(java.lang.String)"><!-- --></A><H3>
374withName</H3>
375<PRE>
376public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</A> <B>withName</B>(<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;newName)</PRE>
377<DL>
378<DD>Method that can be used to create a definition with
379 same settings as this one, but with different
380 (external) name; that is, one for which
381 <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()"><CODE>getName()</CODE></A> would return <code>newName</code>.
382<P>
383<DD><DL>
384</DL>
385</DD>
386<DD><DL>
387</DL>
388</DD>
389</DL>
390<HR>
391
392<A NAME="getName()"><!-- --></A><H3>
393getName</H3>
394<PRE>
395public abstract <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> <B>getName</B>()</PRE>
396<DL>
397<DD>Accessor for name used for external representation (in JSON).
398<P>
399<DD><DL>
400<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/fasterxml/jackson/databind/util/Named.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</A></CODE></DL>
401</DD>
402<DD><DL>
403</DL>
404</DD>
405</DL>
406<HR>
407
408<A NAME="getInternalName()"><!-- --></A><H3>
409getInternalName</H3>
410<PRE>
411public abstract <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> <B>getInternalName</B>()</PRE>
412<DL>
413<DD>Accessor that can be used to determine implicit name from underlying
414 element(s) before possible renaming. This is the "internal"
415 name derived from accessor ("x" from "getX"), and is not based on
416 annotations or naming strategy.
417<P>
418<DD><DL>
419</DL>
420</DD>
421<DD><DL>
422</DL>
423</DD>
424</DL>
425<HR>
426
427<A NAME="isExplicitlyIncluded()"><!-- --></A><H3>
428isExplicitlyIncluded</H3>
429<PRE>
430public abstract boolean <B>isExplicitlyIncluded</B>()</PRE>
431<DL>
432<DD>Accessor that can be called to check whether property was included
433 due to an explicit marker (usually annotation), or just by naming
434 convention.
435<P>
436<DD><DL>
437</DL>
438</DD>
439<DD><DL>
440
441<DT><B>Returns:</B><DD>True if property was explicitly included (usually by having
442   one of components being annotated); false if inclusion was purely
443   due to naming or visibility definitions (that is, implicit)</DL>
444</DD>
445</DL>
446<HR>
447
448<A NAME="couldDeserialize()"><!-- --></A><H3>
449couldDeserialize</H3>
450<PRE>
451public boolean <B>couldDeserialize</B>()</PRE>
452<DL>
453<DD><DL>
454</DL>
455</DD>
456<DD><DL>
457</DL>
458</DD>
459</DL>
460<HR>
461
462<A NAME="couldSerialize()"><!-- --></A><H3>
463couldSerialize</H3>
464<PRE>
465public boolean <B>couldSerialize</B>()</PRE>
466<DL>
467<DD><DL>
468</DL>
469</DD>
470<DD><DL>
471</DL>
472</DD>
473</DL>
474<HR>
475
476<A NAME="hasGetter()"><!-- --></A><H3>
477hasGetter</H3>
478<PRE>
479public abstract boolean <B>hasGetter</B>()</PRE>
480<DL>
481<DD><DL>
482</DL>
483</DD>
484<DD><DL>
485</DL>
486</DD>
487</DL>
488<HR>
489
490<A NAME="hasSetter()"><!-- --></A><H3>
491hasSetter</H3>
492<PRE>
493public abstract boolean <B>hasSetter</B>()</PRE>
494<DL>
495<DD><DL>
496</DL>
497</DD>
498<DD><DL>
499</DL>
500</DD>
501</DL>
502<HR>
503
504<A NAME="hasField()"><!-- --></A><H3>
505hasField</H3>
506<PRE>
507public abstract boolean <B>hasField</B>()</PRE>
508<DL>
509<DD><DL>
510</DL>
511</DD>
512<DD><DL>
513</DL>
514</DD>
515</DL>
516<HR>
517
518<A NAME="hasConstructorParameter()"><!-- --></A><H3>
519hasConstructorParameter</H3>
520<PRE>
521public abstract boolean <B>hasConstructorParameter</B>()</PRE>
522<DL>
523<DD><DL>
524</DL>
525</DD>
526<DD><DL>
527</DL>
528</DD>
529</DL>
530<HR>
531
532<A NAME="getGetter()"><!-- --></A><H3>
533getGetter</H3>
534<PRE>
535public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A> <B>getGetter</B>()</PRE>
536<DL>
537<DD><DL>
538</DL>
539</DD>
540<DD><DL>
541</DL>
542</DD>
543</DL>
544<HR>
545
546<A NAME="getSetter()"><!-- --></A><H3>
547getSetter</H3>
548<PRE>
549public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A> <B>getSetter</B>()</PRE>
550<DL>
551<DD><DL>
552</DL>
553</DD>
554<DD><DL>
555</DL>
556</DD>
557</DL>
558<HR>
559
560<A NAME="getField()"><!-- --></A><H3>
561getField</H3>
562<PRE>
563public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedField.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedField</A> <B>getField</B>()</PRE>
564<DL>
565<DD><DL>
566</DL>
567</DD>
568<DD><DL>
569</DL>
570</DD>
571</DL>
572<HR>
573
574<A NAME="getConstructorParameter()"><!-- --></A><H3>
575getConstructorParameter</H3>
576<PRE>
577public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</A> <B>getConstructorParameter</B>()</PRE>
578<DL>
579<DD><DL>
580</DL>
581</DD>
582<DD><DL>
583</DL>
584</DD>
585</DL>
586<HR>
587
588<A NAME="getAccessor()"><!-- --></A><H3>
589getAccessor</H3>
590<PRE>
591public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A> <B>getAccessor</B>()</PRE>
592<DL>
593<DD>Method used to find accessor (getter, field to access) to use for accessing
594 value of the property.
595 Null if no such member exists.
596<P>
597<DD><DL>
598</DL>
599</DD>
600<DD><DL>
601</DL>
602</DD>
603</DL>
604<HR>
605
606<A NAME="getMutator()"><!-- --></A><H3>
607getMutator</H3>
608<PRE>
609public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A> <B>getMutator</B>()</PRE>
610<DL>
611<DD>Method used to find mutator (constructor parameter, setter, field) to use for
612 changing value of the property.
613 Null if no such member exists.
614<P>
615<DD><DL>
616</DL>
617</DD>
618<DD><DL>
619</DL>
620</DD>
621</DL>
622<HR>
623
624<A NAME="findViews()"><!-- --></A><H3>
625findViews</H3>
626<PRE>
627public <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;[] <B>findViews</B>()</PRE>
628<DL>
629<DD>Method used to find View-inclusion definitions for the property.
630<P>
631<DD><DL>
632</DL>
633</DD>
634<DD><DL>
635</DL>
636</DD>
637</DL>
638<HR>
639
640<A NAME="findReferenceType()"><!-- --></A><H3>
641findReferenceType</H3>
642<PRE>
643public <A HREF="../../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</A> <B>findReferenceType</B>()</PRE>
644<DL>
645<DD>Method used to find whether property is part of a bi-directional
646 reference.
647<P>
648<DD><DL>
649</DL>
650</DD>
651<DD><DL>
652</DL>
653</DD>
654</DL>
655<HR>
656
657<A NAME="isTypeId()"><!-- --></A><H3>
658isTypeId</H3>
659<PRE>
660public boolean <B>isTypeId</B>()</PRE>
661<DL>
662<DD>Method used to check whether this logical property has a marker
663 to indicate it should be used as the type id for polymorphic type
664 handling.
665<P>
666<DD><DL>
667</DL>
668</DD>
669<DD><DL>
670</DL>
671</DD>
672</DL>
673<HR>
674
675<A NAME="findObjectIdInfo()"><!-- --></A><H3>
676findObjectIdInfo</H3>
677<PRE>
678public <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ObjectIdInfo.html" title="class in com.fasterxml.jackson.databind.introspect">ObjectIdInfo</A> <B>findObjectIdInfo</B>()</PRE>
679<DL>
680<DD>Method used to check whether this logical property indicates that
681 value POJOs should be written using additional Object Identifier
682 (or, when multiple references exist, all but first AS Object Identifier).
683<P>
684<DD><DL>
685</DL>
686</DD>
687<DD><DL>
688</DL>
689</DD>
690</DL>
691<HR>
692
693<A NAME="isRequired()"><!-- --></A><H3>
694isRequired</H3>
695<PRE>
696public boolean <B>isRequired</B>()</PRE>
697<DL>
698<DD>Method used to check if this property is expected to have a value;
699 and if none found, should either be considered invalid (and most likely
700 fail deserialization), or handled by other means (by providing default
701 value)
702<P>
703<DD><DL>
704</DL>
705</DD>
706<DD><DL>
707</DL>
708</DD>
709</DL>
710<!-- ========= END OF CLASS DATA ========= -->
711<HR>
712
713
714<!-- ======= START OF BOTTOM NAVBAR ====== -->
715<A NAME="navbar_bottom"><!-- --></A>
716<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
717<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
718<TR>
719<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
720<A NAME="navbar_bottom_firstrow"><!-- --></A>
721<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
722  <TR ALIGN="center" VALIGN="top">
723  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
724  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
725  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
726  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BeanPropertyDefinition.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
727  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
728  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
729  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
730  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
731  </TR>
732</TABLE>
733</TD>
734<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
735</EM>
736</TD>
737</TR>
738
739<TR>
740<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
741&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BasicClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><B>PREV CLASS</B></A>&nbsp;
742&nbsp;<A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><B>NEXT CLASS</B></A></FONT></TD>
743<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
744  <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" target="_top"><B>FRAMES</B></A>  &nbsp;
745&nbsp;<A HREF="BeanPropertyDefinition.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
746&nbsp;<SCRIPT type="text/javascript">
747  <!--
748  if(window==top) {
749    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
750  }
751  //-->
752</SCRIPT>
753<NOSCRIPT>
754  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
755</NOSCRIPT>
756
757
758</FONT></TD>
759</TR>
760<TR>
761<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
762  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
763<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
764DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
765</TR>
766</TABLE>
767<A NAME="skip-navbar_bottom"></A>
768<!-- ======== END OF BOTTOM NAVBAR ======= -->
769
770<HR>
771Copyright &#169; 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved.
772</BODY>
773</HTML>
774