1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_03) on Fri Jan 25 23:29:22 CET 2008 -->
<TITLE>
PropertyDefinition (JiBX Java data binding to XML - Version 1.0)
</TITLE>
<META NAME="date" CONTENT="2008-01-25">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PropertyDefinition (JiBX Java data binding to XML - Version 1.0)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jibx/binding/def/PrimitiveStringConversion.html" title="class in org.jibx.binding.def"><B>PREV CLASS</B></A>
<A HREF="../../../../org/jibx/binding/def/StringConversion.html" title="class in org.jibx.binding.def"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jibx/binding/def/PropertyDefinition.html" target="_top"><B>FRAMES</B></A>
<A HREF="PropertyDefinition.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.jibx.binding.def</FONT>
<BR>
Class PropertyDefinition</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.jibx.binding.def.PropertyDefinition</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>PropertyDefinition</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Property definition from binding. This organizes shared information for
bindings linked to fields or get/set methods of an object, and provides
methods for related code generation.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>1.0</DD>
<DT><B>Author:</B></DT>
<DD>Dennis M. Sosnoski</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_fieldItem">m_fieldItem</A></B></CODE>
<BR>
Information for field (if given, may be <code>null</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_getMethod">m_getMethod</A></B></CODE>
<BR>
Information for get method (if given, may be <code>null</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_getValueType">m_getValueType</A></B></CODE>
<BR>
Fully qualified name of declared type of value loaded.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_isImplicit">m_isImplicit</A></B></CODE>
<BR>
Reference to implicit value from collection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_isOptional">m_isOptional</A></B></CODE>
<BR>
Optional item flag.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_isThis">m_isThis</A></B></CODE>
<BR>
Reference to "this" property of object flag.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private <A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_objContext">m_objContext</A></B></CODE>
<BR>
Containing object context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_setMethod">m_setMethod</A></B></CODE>
<BR>
Information for set method (if given, may be <code>null</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_setValueType">m_setValueType</A></B></CODE>
<BR>
Fully qualified name of declared type of value stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_testMethod">m_testMethod</A></B></CODE>
<BR>
Information for test method (if given, may be <code>null</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#m_typeName">m_typeName</A></B></CODE>
<BR>
Fully qualified name of actual type of value.</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#PropertyDefinition(org.jibx.binding.def.IContainer, org.jibx.binding.def.IContextObj, java.lang.String, boolean, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">PropertyDefinition</A></B>(<A HREF="../../../../org/jibx/binding/def/IContainer.html" title="interface in org.jibx.binding.def">IContainer</A> parent,
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> obj,
java.lang.String type,
boolean isthis,
boolean opt,
java.lang.String fname,
java.lang.String test,
java.lang.String get,
java.lang.String set)</CODE>
<BR>
Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#PropertyDefinition(org.jibx.binding.def.IContextObj, boolean)">PropertyDefinition</A></B>(<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> obj,
boolean opt)</CODE>
<BR>
Constructor for "this" object reference.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#PropertyDefinition(java.lang.String, org.jibx.binding.def.IContextObj, boolean)">PropertyDefinition</A></B>(java.lang.String type,
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> obj,
boolean opt)</CODE>
<BR>
Constructor for implicit object reference.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#genLoad(org.jibx.binding.classes.MethodBuilder)">genLoad</A></B>(<A HREF="../../../../org/jibx/binding/classes/MethodBuilder.html" title="class in org.jibx.binding.classes">MethodBuilder</A> mb)</CODE>
<BR>
Generate code to load property value to stack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#genStore(org.jibx.binding.classes.MethodBuilder)">genStore</A></B>(<A HREF="../../../../org/jibx/binding/classes/MethodBuilder.html" title="class in org.jibx.binding.classes">MethodBuilder</A> mb)</CODE>
<BR>
Generate code to store property value from stack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/jibx/binding/classes/BranchWrapper.html" title="class in org.jibx.binding.classes">BranchWrapper</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#genTest(org.jibx.binding.classes.ContextMethodBuilder)">genTest</A></B>(<A HREF="../../../../org/jibx/binding/classes/ContextMethodBuilder.html" title="class in org.jibx.binding.classes">ContextMethodBuilder</A> mb)</CODE>
<BR>
Generate code to test if property is present.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#getGetValueType()">getGetValueType</A></B>()</CODE>
<BR>
Get value type as fully qualified name for loaded property value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#getName()">getName</A></B>()</CODE>
<BR>
Get property name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#getSetValueType()">getSetValueType</A></B>()</CODE>
<BR>
Get value type as fully qualified name for stored property value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#getTypeName()">getTypeName</A></B>()</CODE>
<BR>
Get declared type fully qualified name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#hasTest()">hasTest</A></B>()</CODE>
<BR>
Check if property has presence test.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#isImplicit()">isImplicit</A></B>()</CODE>
<BR>
Check if property is implicit value from collection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#isOptional()">isOptional</A></B>()</CODE>
<BR>
Check if property is optional.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#isThis()">isThis</A></B>()</CODE>
<BR>
Check if property is "this" reference for object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#setOptional(boolean)">setOptional</A></B>(boolean opt)</CODE>
<BR>
Set flag for an optional property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html#toString()">toString</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="m_isThis"><!-- --></A><H3>
m_isThis</H3>
<PRE>
private final boolean <B>m_isThis</B></PRE>
<DL>
<DD>Reference to "this" property of object flag.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_isImplicit"><!-- --></A><H3>
m_isImplicit</H3>
<PRE>
private final boolean <B>m_isImplicit</B></PRE>
<DL>
<DD>Reference to implicit value from collection.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_isOptional"><!-- --></A><H3>
m_isOptional</H3>
<PRE>
private boolean <B>m_isOptional</B></PRE>
<DL>
<DD>Optional item flag.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_objContext"><!-- --></A><H3>
m_objContext</H3>
<PRE>
private final <A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> <B>m_objContext</B></PRE>
<DL>
<DD>Containing object context.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_typeName"><!-- --></A><H3>
m_typeName</H3>
<PRE>
private final java.lang.String <B>m_typeName</B></PRE>
<DL>
<DD>Fully qualified name of actual type of value.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_getValueType"><!-- --></A><H3>
m_getValueType</H3>
<PRE>
private final java.lang.String <B>m_getValueType</B></PRE>
<DL>
<DD>Fully qualified name of declared type of value loaded.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_setValueType"><!-- --></A><H3>
m_setValueType</H3>
<PRE>
private final java.lang.String <B>m_setValueType</B></PRE>
<DL>
<DD>Fully qualified name of declared type of value stored.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_fieldItem"><!-- --></A><H3>
m_fieldItem</H3>
<PRE>
private final <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A> <B>m_fieldItem</B></PRE>
<DL>
<DD>Information for field (if given, may be <code>null</code>).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_testMethod"><!-- --></A><H3>
m_testMethod</H3>
<PRE>
private final <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A> <B>m_testMethod</B></PRE>
<DL>
<DD>Information for test method (if given, may be <code>null</code>).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_getMethod"><!-- --></A><H3>
m_getMethod</H3>
<PRE>
private final <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A> <B>m_getMethod</B></PRE>
<DL>
<DD>Information for get method (if given, may be <code>null</code>).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_setMethod"><!-- --></A><H3>
m_setMethod</H3>
<PRE>
private final <A HREF="../../../../org/jibx/binding/classes/ClassItem.html" title="class in org.jibx.binding.classes">ClassItem</A> <B>m_setMethod</B></PRE>
<DL>
<DD>Information for set method (if given, may be <code>null</code>).
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="PropertyDefinition(org.jibx.binding.def.IContainer, org.jibx.binding.def.IContextObj, java.lang.String, boolean, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
PropertyDefinition</H3>
<PRE>
public <B>PropertyDefinition</B>(<A HREF="../../../../org/jibx/binding/def/IContainer.html" title="interface in org.jibx.binding.def">IContainer</A> parent,
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> obj,
java.lang.String type,
boolean isthis,
boolean opt,
java.lang.String fname,
java.lang.String test,
java.lang.String get,
java.lang.String set)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Constructor.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - containing binding definition structure<DD><CODE>obj</CODE> - containing object context<DD><CODE>type</CODE> - fully qualified name of type<DD><CODE>isthis</CODE> - "this" object reference flag<DD><CODE>opt</CODE> - optional property flag<DD><CODE>fname</CODE> - containing object field name for property (may be
<code>null</code>)<DD><CODE>test</CODE> - containing object method to test for property present (may be
<code>null</code>)<DD><CODE>get</CODE> - containing object method to get property value (may be
<code>null</code>)<DD><CODE>set</CODE> - containing object method to set property value (may be
<code>null</code>)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if configuration error</DL>
</DL>
<HR>
<A NAME="PropertyDefinition(org.jibx.binding.def.IContextObj, boolean)"><!-- --></A><H3>
PropertyDefinition</H3>
<PRE>
public <B>PropertyDefinition</B>(<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> obj,
boolean opt)</PRE>
<DL>
<DD>Constructor for "this" object reference.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - containing object context<DD><CODE>opt</CODE> - optional property flag</DL>
</DL>
<HR>
<A NAME="PropertyDefinition(java.lang.String, org.jibx.binding.def.IContextObj, boolean)"><!-- --></A><H3>
PropertyDefinition</H3>
<PRE>
public <B>PropertyDefinition</B>(java.lang.String type,
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> obj,
boolean opt)</PRE>
<DL>
<DD>Constructor for implicit object reference.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - object type supplied<DD><CODE>obj</CODE> - containing object context<DD><CODE>opt</CODE> - optional property flag</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="isThis()"><!-- --></A><H3>
isThis</H3>
<PRE>
public boolean <B>isThis</B>()</PRE>
<DL>
<DD>Check if property is "this" reference for object.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if reference to "this", <code>false</code> if
not</DL>
</DD>
</DL>
<HR>
<A NAME="isImplicit()"><!-- --></A><H3>
isImplicit</H3>
<PRE>
public boolean <B>isImplicit</B>()</PRE>
<DL>
<DD>Check if property is implicit value from collection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if implicit, <code>false</code> if not</DL>
</DD>
</DL>
<HR>
<A NAME="isOptional()"><!-- --></A><H3>
isOptional</H3>
<PRE>
public boolean <B>isOptional</B>()</PRE>
<DL>
<DD>Check if property is optional.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if optional, <code>false</code> if required</DL>
</DD>
</DL>
<HR>
<A NAME="setOptional(boolean)"><!-- --></A><H3>
setOptional</H3>
<PRE>
public void <B>setOptional</B>(boolean opt)</PRE>
<DL>
<DD>Set flag for an optional property.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>opt</CODE> - <code>true</code> if optional property, <code>false</code> if
not</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Get property name. If a field is defined this is the same as the field;
otherwise it is either the get method name (with leading "get" stripped,
if present) or the set method (with leading "set" stripped, if present),
whichever is found.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>name for this property</DL>
</DD>
</DL>
<HR>
<A NAME="getTypeName()"><!-- --></A><H3>
getTypeName</H3>
<PRE>
public java.lang.String <B>getTypeName</B>()</PRE>
<DL>
<DD>Get declared type fully qualified name.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>fully qualified class name of declared type</DL>
</DD>
</DL>
<HR>
<A NAME="getGetValueType()"><!-- --></A><H3>
getGetValueType</H3>
<PRE>
public java.lang.String <B>getGetValueType</B>()</PRE>
<DL>
<DD>Get value type as fully qualified name for loaded property value.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>fully qualified class name of value type</DL>
</DD>
</DL>
<HR>
<A NAME="getSetValueType()"><!-- --></A><H3>
getSetValueType</H3>
<PRE>
public java.lang.String <B>getSetValueType</B>()</PRE>
<DL>
<DD>Get value type as fully qualified name for stored property value.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>fully qualified class name of value type</DL>
</DD>
</DL>
<HR>
<A NAME="hasTest()"><!-- --></A><H3>
hasTest</H3>
<PRE>
public boolean <B>hasTest</B>()</PRE>
<DL>
<DD>Check if property has presence test. Code needs to be generated to check
for the presence of the property if it is optional and either a test
method is defined or the value is an object reference.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if presence test needed, <code>false</code> if
not</DL>
</DD>
</DL>
<HR>
<A NAME="genTest(org.jibx.binding.classes.ContextMethodBuilder)"><!-- --></A><H3>
genTest</H3>
<PRE>
public <A HREF="../../../../org/jibx/binding/classes/BranchWrapper.html" title="class in org.jibx.binding.classes">BranchWrapper</A> <B>genTest</B>(<A HREF="../../../../org/jibx/binding/classes/ContextMethodBuilder.html" title="class in org.jibx.binding.classes">ContextMethodBuilder</A> mb)</PRE>
<DL>
<DD>Generate code to test if property is present. The generated code
assumes that the top of the stack is the reference for the containing
object, and consumes this value for the test. The target for the
returned branch instruction must be set by the caller.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mb</CODE> - method builder
<DT><B>Returns:</B><DD>wrapper for branch instruction taken when property is missing</DL>
</DD>
</DL>
<HR>
<A NAME="genLoad(org.jibx.binding.classes.MethodBuilder)"><!-- --></A><H3>
genLoad</H3>
<PRE>
public void <B>genLoad</B>(<A HREF="../../../../org/jibx/binding/classes/MethodBuilder.html" title="class in org.jibx.binding.classes">MethodBuilder</A> mb)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Generate code to load property value to stack. The generated code
assumes that the top of the stack is the reference for the containing
object. It consumes this and leaves the actual value on the stack. If
the property value is not directly accessible from the context of the
method being generated this automatically constructs an access method
and uses that method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mb</CODE> - method builder
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if configuration error</DL>
</DD>
</DL>
<HR>
<A NAME="genStore(org.jibx.binding.classes.MethodBuilder)"><!-- --></A><H3>
genStore</H3>
<PRE>
public void <B>genStore</B>(<A HREF="../../../../org/jibx/binding/classes/MethodBuilder.html" title="class in org.jibx.binding.classes">MethodBuilder</A> mb)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Generate code to store property value from stack. The generated code
assumes that the reference to the containing object and the value to be
stored have already been pushed on the stack. It consumes these, leaving
nothing. If the property value is not directly accessible from the
context of the method being generated this automatically constructs an
access method and uses that method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mb</CODE> - method builder
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if configuration error</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jibx/binding/def/PrimitiveStringConversion.html" title="class in org.jibx.binding.def"><B>PREV CLASS</B></A>
<A HREF="../../../../org/jibx/binding/def/StringConversion.html" title="class in org.jibx.binding.def"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jibx/binding/def/PropertyDefinition.html" target="_top"><B>FRAMES</B></A>
<A HREF="PropertyDefinition.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<table width='80%%'><tr><td width='50%%'><p align='center'><a href='http://www.jibx.org/' target='_top'><font size='3'><b>Project Web Site</b></font></a></td><td width='50%%'><p align='center'></td></tr></table>
</BODY>
</HTML>
|
