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
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
|
<!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:21 CET 2008 -->
<TITLE>
BindingGenerator (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="BindingGenerator (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">
PREV CLASS
<A HREF="../../../org/jibx/binding/Compile.html" title="class in org.jibx.binding"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/jibx/binding/BindingGenerator.html" target="_top"><B>FRAMES</B></A>
<A HREF="BindingGenerator.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</FONT>
<BR>
Class BindingGenerator</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.jibx.binding.BindingGenerator</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>BindingGenerator</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Binding generator. This loads the specified input classes and processes them
to generate a default binding definition.
<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 static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#CURRENT_VERSION">CURRENT_VERSION</A></B></CODE>
<BR>
Generator version.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.util.HashMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#m_beanNames">m_beanNames</A></B></CODE>
<BR>
Class names to properties list map.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.util.HashMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#m_enumerationNames">m_enumerationNames</A></B></CODE>
<BR>
Class names to deserializers map for typesafe enumerations.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.util.HashSet</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#m_ignoreNames">m_ignoreNames</A></B></CODE>
<BR>
Class names to be treated like interfaces (not mapped directly).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.util.HashMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#m_mappedNames">m_mappedNames</A></B></CODE>
<BR>
Class names to mapped element names map.</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/BindingGenerator.html#m_mixedCase">m_mixedCase</A></B></CODE>
<BR>
Use camel case for XML names flag.</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/BindingGenerator.html#m_namespaceUri">m_namespaceUri</A></B></CODE>
<BR>
Namespace URI for elements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.util.HashSet</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#m_structureNames">m_structureNames</A></B></CODE>
<BR>
Class names bound as nested structures.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private org.jibx.binding.util.ObjectStack</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#m_structureStack">m_structureStack</A></B></CODE>
<BR>
Stack of structure definitions in progress (used to detect cycles).</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/BindingGenerator.html#m_verbose">m_verbose</A></B></CODE>
<BR>
Show verbose output flag.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static java.util.HashSet</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#s_objectPrimitiveSet">s_objectPrimitiveSet</A></B></CODE>
<BR>
Set of objects treated as primitives.</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/BindingGenerator.html#BindingGenerator()">BindingGenerator</A></B>()</CODE>
<BR>
Default constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#BindingGenerator(boolean, boolean, java.lang.String)">BindingGenerator</A></B>(boolean verbose,
boolean mixed,
java.lang.String uri)</CODE>
<BR>
Constructor with settings specified.</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>private java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#convertName(java.lang.String)">convertName</A></B>(java.lang.String base)</CODE>
<BR>
Convert class or unprefixed field name to element or attribute name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private org.jibx.binding.model.MappingElement</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#createMapping(org.jibx.binding.classes.ClassFile, boolean)">createMapping</A></B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
boolean abstr)</CODE>
<BR>
Create the mapping element for a particular class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private org.jibx.binding.model.StructureElement</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#createStructure(org.jibx.binding.classes.ClassFile, java.lang.String)">createStructure</A></B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
java.lang.String fname)</CODE>
<BR>
Create the structure element for a particular class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#defineFields(org.jibx.binding.classes.ClassFile, org.jibx.binding.model.ContainerElementBase)">defineFields</A></B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
org.jibx.binding.model.ContainerElementBase contain)</CODE>
<BR>
Construct the list of child binding components that define the binding
structure for fields of a particular class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#defineProperties(org.jibx.binding.classes.ClassFile, java.util.ArrayList, boolean, org.jibx.binding.model.ContainerElementBase)">defineProperties</A></B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
java.util.ArrayList props,
boolean internal,
org.jibx.binding.model.ContainerElementBase contain)</CODE>
<BR>
Construct the list of child binding components that define the binding
structure corresponding to properties of a particular class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#defineStructure(org.jibx.binding.classes.ClassFile, org.jibx.binding.model.ContainerElementBase)">defineStructure</A></B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
org.jibx.binding.model.ContainerElementBase contain)</CODE>
<BR>
Construct the list of child binding components that define the binding
structure corresponding to a particular class.</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/BindingGenerator.html#elementName(java.lang.String)">elementName</A></B>(java.lang.String cname)</CODE>
<BR>
Generate structure element name from class name using set conversions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#findClassesUsed(java.lang.String, java.util.ArrayList, java.util.HashSet, java.util.HashSet)">findClassesUsed</A></B>(java.lang.String cname,
java.util.ArrayList mnames,
java.util.HashSet dataset,
java.util.HashSet exceptset)</CODE>
<BR>
Get the set of data classes passed to or returned by a list of methods
within a class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.jibx.binding.model.BindingElement</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#generate(java.util.ArrayList, java.util.HashSet, java.util.HashMap, java.util.HashMap, java.util.HashMap, java.util.ArrayList)">generate</A></B>(java.util.ArrayList names,
java.util.HashSet abstracts,
java.util.HashMap customs,
java.util.HashMap beans,
java.util.HashMap enums,
java.util.ArrayList ignores)</CODE>
<BR>
Generate a set of bindings using supplied classpaths and class names.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#isMappable(java.lang.String)">isMappable</A></B>(java.lang.String cname)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
<BR>
Main method for running compiler as application.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jibx/binding/BindingGenerator.html#nestingIndent(java.io.PrintStream)">nestingIndent</A></B>(java.io.PrintStream pw)</CODE>
<BR>
Indent to proper depth for current item.</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/BindingGenerator.html#setCamelCase(boolean)">setCamelCase</A></B>(boolean camel)</CODE>
<BR>
Set control flag for camel case element naming.</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/BindingGenerator.html#setVerbose(boolean)">setVerbose</A></B>(boolean verbose)</CODE>
<BR>
Set control flag for verbose processing reports.</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/BindingGenerator.html#valueName(java.lang.String)">valueName</A></B>(java.lang.String fname)</CODE>
<BR>
Generate structure element name from class name using set conversions.</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, toString, 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="CURRENT_VERSION"><!-- --></A><H3>
CURRENT_VERSION</H3>
<PRE>
private static java.lang.String <B>CURRENT_VERSION</B></PRE>
<DL>
<DD>Generator version.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="s_objectPrimitiveSet"><!-- --></A><H3>
s_objectPrimitiveSet</H3>
<PRE>
private static java.util.HashSet <B>s_objectPrimitiveSet</B></PRE>
<DL>
<DD>Set of objects treated as primitives.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_verbose"><!-- --></A><H3>
m_verbose</H3>
<PRE>
private boolean <B>m_verbose</B></PRE>
<DL>
<DD>Show verbose output flag.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_mixedCase"><!-- --></A><H3>
m_mixedCase</H3>
<PRE>
private boolean <B>m_mixedCase</B></PRE>
<DL>
<DD>Use camel case for XML names flag.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_namespaceUri"><!-- --></A><H3>
m_namespaceUri</H3>
<PRE>
private java.lang.String <B>m_namespaceUri</B></PRE>
<DL>
<DD>Namespace URI for elements.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_mappedNames"><!-- --></A><H3>
m_mappedNames</H3>
<PRE>
private java.util.HashMap <B>m_mappedNames</B></PRE>
<DL>
<DD>Class names to mapped element names map.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_beanNames"><!-- --></A><H3>
m_beanNames</H3>
<PRE>
private java.util.HashMap <B>m_beanNames</B></PRE>
<DL>
<DD>Class names to properties list map.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_enumerationNames"><!-- --></A><H3>
m_enumerationNames</H3>
<PRE>
private java.util.HashMap <B>m_enumerationNames</B></PRE>
<DL>
<DD>Class names to deserializers map for typesafe enumerations.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_structureStack"><!-- --></A><H3>
m_structureStack</H3>
<PRE>
private org.jibx.binding.util.ObjectStack <B>m_structureStack</B></PRE>
<DL>
<DD>Stack of structure definitions in progress (used to detect cycles).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_structureNames"><!-- --></A><H3>
m_structureNames</H3>
<PRE>
private java.util.HashSet <B>m_structureNames</B></PRE>
<DL>
<DD>Class names bound as nested structures.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_ignoreNames"><!-- --></A><H3>
m_ignoreNames</H3>
<PRE>
private java.util.HashSet <B>m_ignoreNames</B></PRE>
<DL>
<DD>Class names to be treated like interfaces (not mapped directly).
<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="BindingGenerator()"><!-- --></A><H3>
BindingGenerator</H3>
<PRE>
public <B>BindingGenerator</B>()</PRE>
<DL>
<DD>Default constructor. This just initializes all options disabled.
<P>
</DL>
<HR>
<A NAME="BindingGenerator(boolean, boolean, java.lang.String)"><!-- --></A><H3>
BindingGenerator</H3>
<PRE>
public <B>BindingGenerator</B>(boolean verbose,
boolean mixed,
java.lang.String uri)</PRE>
<DL>
<DD>Constructor with settings specified.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - report binding details and results<DD><CODE>mixed</CODE> - use camel case in element names<DD><CODE>uri</CODE> - namespace URI for element bindings</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="setVerbose(boolean)"><!-- --></A><H3>
setVerbose</H3>
<PRE>
public void <B>setVerbose</B>(boolean verbose)</PRE>
<DL>
<DD>Set control flag for verbose processing reports.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - report verbose information in processing bindings flag</DL>
</DD>
</DL>
<HR>
<A NAME="setCamelCase(boolean)"><!-- --></A><H3>
setCamelCase</H3>
<PRE>
public void <B>setCamelCase</B>(boolean camel)</PRE>
<DL>
<DD>Set control flag for camel case element naming.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>camel</CODE> - use camel case element naming flag</DL>
</DD>
</DL>
<HR>
<A NAME="nestingIndent(java.io.PrintStream)"><!-- --></A><H3>
nestingIndent</H3>
<PRE>
private void <B>nestingIndent</B>(java.io.PrintStream pw)</PRE>
<DL>
<DD>Indent to proper depth for current item.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pw</CODE> - output print stream to be indented</DL>
</DD>
</DL>
<HR>
<A NAME="convertName(java.lang.String)"><!-- --></A><H3>
convertName</H3>
<PRE>
private java.lang.String <B>convertName</B>(java.lang.String base)</PRE>
<DL>
<DD>Convert class or unprefixed field name to element or attribute name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>base</CODE> - class or simple field name to be converted
<DT><B>Returns:</B><DD>element or attribute name</DL>
</DD>
</DL>
<HR>
<A NAME="elementName(java.lang.String)"><!-- --></A><H3>
elementName</H3>
<PRE>
public java.lang.String <B>elementName</B>(java.lang.String cname)</PRE>
<DL>
<DD>Generate structure element name from class name using set conversions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cname</CODE> - class name to be converted
<DT><B>Returns:</B><DD>element name for instances of class</DL>
</DD>
</DL>
<HR>
<A NAME="valueName(java.lang.String)"><!-- --></A><H3>
valueName</H3>
<PRE>
private java.lang.String <B>valueName</B>(java.lang.String fname)</PRE>
<DL>
<DD>Generate structure element name from class name using set conversions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fname</CODE> - field name to be converted
<DT><B>Returns:</B><DD>element name for instances of class</DL>
</DD>
</DL>
<HR>
<A NAME="defineFields(org.jibx.binding.classes.ClassFile, org.jibx.binding.model.ContainerElementBase)"><!-- --></A><H3>
defineFields</H3>
<PRE>
private void <B>defineFields</B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
org.jibx.binding.model.ContainerElementBase contain)
throws <A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Construct the list of child binding components that define the binding
structure for fields of a particular class. This binds all
non-final/non-static/non-transient fields of the class, if necessary
creating nested structure elements for unmapped classes referenced by the
fields.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cf</CODE> - class information<DD><CODE>contain</CODE> - binding structure container element
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - on error in binding generation</DL>
</DD>
</DL>
<HR>
<A NAME="defineProperties(org.jibx.binding.classes.ClassFile, java.util.ArrayList, boolean, org.jibx.binding.model.ContainerElementBase)"><!-- --></A><H3>
defineProperties</H3>
<PRE>
private void <B>defineProperties</B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
java.util.ArrayList props,
boolean internal,
org.jibx.binding.model.ContainerElementBase contain)
throws <A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Construct the list of child binding components that define the binding
structure corresponding to properties of a particular class. This binds
the specified properties of the class, using get/set methods, if
necessary creating nested structure elements for unmapped classes
referenced by the properties.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cf</CODE> - class information<DD><CODE>props</CODE> - list of properties specified for class<DD><CODE>internal</CODE> - allow private get/set methods flag<DD><CODE>contain</CODE> - binding structure container element
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - on error in binding generation</DL>
</DD>
</DL>
<HR>
<A NAME="defineStructure(org.jibx.binding.classes.ClassFile, org.jibx.binding.model.ContainerElementBase)"><!-- --></A><H3>
defineStructure</H3>
<PRE>
private void <B>defineStructure</B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
org.jibx.binding.model.ContainerElementBase contain)
throws <A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Construct the list of child binding components that define the binding
structure corresponding to a particular class. This binds all
non-final/non-static/non-transient fields of the class, if necessary
creating nested structure elements for unmapped classes referenced by the
fields.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cf</CODE> - class information<DD><CODE>contain</CODE> - binding structure container element
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - on error in binding generation</DL>
</DD>
</DL>
<HR>
<A NAME="createStructure(org.jibx.binding.classes.ClassFile, java.lang.String)"><!-- --></A><H3>
createStructure</H3>
<PRE>
private org.jibx.binding.model.StructureElement <B>createStructure</B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
java.lang.String fname)
throws <A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Create the structure element for a particular class. This maps all
non-final/non-static/non-transient fields of the class, if necessary
creating nested structures.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cf</CODE> - class information<DD><CODE>fname</CODE> - name of field supplying reference
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - on error in binding generation</DL>
</DD>
</DL>
<HR>
<A NAME="createMapping(org.jibx.binding.classes.ClassFile, boolean)"><!-- --></A><H3>
createMapping</H3>
<PRE>
private org.jibx.binding.model.MappingElement <B>createMapping</B>(<A HREF="../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf,
boolean abstr)
throws <A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Create the mapping element for a particular class. This maps all
non-final/non-static/non-transient fields of the class, if necessary
creating nested structures.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cf</CODE> - class information<DD><CODE>abstr</CODE> - force abstract mapping flag
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - on error in binding generation</DL>
</DD>
</DL>
<HR>
<A NAME="isMappable(java.lang.String)"><!-- --></A><H3>
isMappable</H3>
<PRE>
private static boolean <B>isMappable</B>(java.lang.String cname)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="findClassesUsed(java.lang.String, java.util.ArrayList, java.util.HashSet, java.util.HashSet)"><!-- --></A><H3>
findClassesUsed</H3>
<PRE>
public static void <B>findClassesUsed</B>(java.lang.String cname,
java.util.ArrayList mnames,
java.util.HashSet dataset,
java.util.HashSet exceptset)
throws <A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Get the set of data classes passed to or returned by a list of methods
within a class. The classes returned exclude primitive types, wrappers,
<code>java.lang.String</code>, and <code>java.lang.Object</code>.
Exception classes thrown by the methods are also optionally accumulated.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cname</CODE> - target class name<DD><CODE>mnames</CODE> - method names to be checked<DD><CODE>dataset</CODE> - set for accumulation of data classes (optional, data
classes not recorded if <code>null</code>)<DD><CODE>exceptset</CODE> - set for accumulation of exception classes (optional,
data classes not recorded if <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> - on error in loading class information</DL>
</DD>
</DL>
<HR>
<A NAME="generate(java.util.ArrayList, java.util.HashSet, java.util.HashMap, java.util.HashMap, java.util.HashMap, java.util.ArrayList)"><!-- --></A><H3>
generate</H3>
<PRE>
public org.jibx.binding.model.BindingElement <B>generate</B>(java.util.ArrayList names,
java.util.HashSet abstracts,
java.util.HashMap customs,
java.util.HashMap beans,
java.util.HashMap enums,
java.util.ArrayList ignores)
throws <A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Generate a set of bindings using supplied classpaths and class names.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>names</CODE> - list of class names to be included in binding<DD><CODE>abstracts</CODE> - set of classes to be handled with abstract mappings in
binding<DD><CODE>customs</CODE> - map of customized class names to marshaller/unmarshaller
class names<DD><CODE>beans</CODE> - map of class names to supplied lists of properties<DD><CODE>enums</CODE> - map of typesafe enumeration classes to deserializer methods<DD><CODE>ignores</CODE> - list of non-interface classes to be treated as interfaces
(no mapping, but mapped subclasses are used at runtime)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if error in generating the binding definition</DL>
</DD>
</DL>
<HR>
<A NAME="main(java.lang.String[])"><!-- --></A><H3>
main</H3>
<PRE>
public static void <B>main</B>(java.lang.String[] args)</PRE>
<DL>
<DD>Main method for running compiler as application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - command line arguments</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">
PREV CLASS
<A HREF="../../../org/jibx/binding/Compile.html" title="class in org.jibx.binding"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/jibx/binding/BindingGenerator.html" target="_top"><B>FRAMES</B></A>
<A HREF="BindingGenerator.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>
|
