File: bindcomp.html

package info (click to toggle)
libjibx1.2-java 1.2.6-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 26,144 kB
  • ctags: 24,132
  • sloc: java: 75,013; xml: 14,068; makefile: 36; sh: 13
file content (728 lines) | stat: -rw-r--r-- 30,060 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>Using the Binding Compiler</title>
      <style type="text/css">
        @import url("./style/tigris.css");
        @import url("./style/maven.css");
    .dtd-comment {
      color: #993399;
      font-weight: bold;
      </style>
      <script type="text/javascript">
        if (document.layers) {
          document.writeln('<link rel="stylesheet" type="text/css" href="./style/ns4_only.css" media="screen" /><link rel="stylesheet" type="text/css" href="./style/maven_ns4_only.css" media="screen" />')
        }
      </script>
      <link rel="stylesheet" type="text/css" href="./style/print.css" media="print" />
  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
</head>
<body class="composite">
<div id="banner">
<table border="0" cellspacing="0" cellpadding="8" width="100%">
  <tbody>
    <tr>
      <td><h1>Using the Binding Compiler</h1>
      </td>
      <td>
      <div align="right" id="login"><a href="http://sourceforge.net/projects/jibx"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=69358&type=16" width="150" height="40" border="0" alt="Get JiBX - XML Data Binding for Java at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a></div>
      </td>
    </tr>
  </tbody>
</table>
</div>
<div id="breadcrumbs">
<table border="0" cellspacing="0" cellpadding="4" width="100%">
  <tbody>
    <tr>
      <td>
        <div align="right">
          <a href="./index.html">Home Page</a> |
          <a href="http://www.sourceforge.net/projects/jibx/">SourceForge Page</a> |
          <a href="./mail-lists.html">Mailing Lists</a> |
          <a href="./bugs.html">Bugs</a> |
          <a href="http://sourceforge.net/project/showfiles.php?group_id=69358">Downloads</a>
        </div>
      </td>
    </tr>
  </tbody>
</table>
</div>
<table border="0" cellspacing="0" cellpadding="8" width="100%" id="main">
  <tbody>
	<tr valign="top">
	  <td id="leftcol" width="20%">
		<div id="navcolumn">


                  <div>
            <strong>JiBX Basics</strong>
                              <div>
            <small>
                    <a href="index.html">Overview</a>
                  </small>
                              <div>
            <small>
                    <a href="getting-started.html">Getting Started</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <span class="menu-selection">Binding Compiler</span>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="bindonload.html">Binding on Load</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="runtime.html">Runtime</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="extras.html">Extras</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="building.html">Building JiBX</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="./jibx-maven-plugin/index.html">Maven</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="contributing.html">Contributing</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="jibx-license.html">License</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="status.html">News and Status</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="support.html">Support</a>
                  </small>
                              <div>
            <small>
                    <a href="faq.html">FAQ</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="mail-lists.html">Mailing Lists</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="bugs.html">Bugs</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="comments.html">User Comments</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="sponsors.html">Sponsors</a>
                  </small>
                </div>
                      </div>
                        <div>
            <strong>Start from Code</strong>
                              <div>
            <small>
                    <a href="fromcode/index.html">Start from Code</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromcode/bindgen.html">BindGen</a>
                  </small>
                              <div>
            <small>
                    <a href="fromcode/bindgen-examples.html">Example Code</a>
                  </small>
                              <div>
            <small>
                    <a href="fromcode/bindgen-example1.html">Example 1</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromcode/bindgen-example2.html">Example 2</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromcode/bindgen-example3.html">Example 3</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromcode/bindgen-example4.html">Example 4</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="fromcode/bindgen-customs.html">Customizations Reference</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="fromcode/schemagen.html">SchemaGen</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromcode/jibx2wsdl.html">Jibx2Wsdl</a>
                  </small>
                              <div>
            <small>
                    <a href="fromcode/jibx2wsdl-examples.html">Examples</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromcode/jibx2wsdl-customs.html">Customizations</a>
                  </small>
                </div>
                      </div>
                      </div>
                        <div>
            <strong>Start from Schema</strong>
                              <div>
            <small>
                    <a href="fromschema/index.html">Start from Schema</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/codegen.html">CodeGen</a>
                  </small>
                              <div>
            <small>
                    <a href="fromschema/codegen-types.html">Schema Datatype Handling</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/codegen-examples.html">Example Code</a>
                  </small>
                              <div>
            <small>
                    <a href="fromschema/example-default.html">Default Generation</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/example-custom1.html">Simple Customizations</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/example-custom2.html">More Customizations</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/example-modular.html">Modular Generation</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="fromschema/codegen-customs.html">Customizations Reference</a>
                  </small>
                              <div>
            <small>
                    <a href="fromschema/codegen-extends.html">Extensions Reference</a>
                  </small>
                </div>
                      </div>
                      </div>
                      </div>
                        <div>
            <strong>Binding Definition</strong>
                              <div>
            <small>
                    <a href="binding/tutorial/binding-tutorial.html">Binding Tutorial</a>
                  </small>
                              <div>
            <small>
                    <a href="binding/tutorial/binding-start.html">A basic binding</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/tutorial/binding-extras.html">Binding extras</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/tutorial/binding-structures.html">Structure mapping</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/tutorial/binding-collects.html">Collections and arrays</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/tutorial/binding-mappings.html">Using mappings</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/tutorial/binding-advanced.html">Advanced binding</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/tutorial/binding-extend.html">Method hooks</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/tutorial/binding-custom.html">Custom code</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="binding/precompiled.html">Precompiled Bindings</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/binding-overview.html">Definition details</a>
                  </small>
                              <div>
            <small>
                    <a href="binding/contexts.html">Definition contexts</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/conversions.html">Conversions</a>
                  </small>
                              <div>
            <small>
                    <a href="binding/date-time.html">Date/time conversions</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="binding/xml-summary.html">XML summary</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/binding-element.html">&lt;binding&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/include-element.html">&lt;include&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/format-element.html">&lt;format&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/namespace-element.html">&lt;namespace&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/mapping-element.html">&lt;mapping&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/value-element.html">&lt;value&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/structure-element.html">&lt;structure&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/collection-element.html">&lt;collection&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="binding/binding-attributes.html">Attribute groups</a>
                  </small>
                </div>
                      </div>
                      </div>
                        <div>
            <strong>Usage API</strong>
                              <div>
            <small>
                    <a href="./api/index.html">Runtime JavaDocs</a>
                  </small>
                </div>
                      </div>
                        <div>
            <strong>Subprojects</strong>
                              <div>
            <small>
                    <a href="eclipse/index.html">Eclipse Plug-in</a>
                  </small>
                              <div>
            <small>
                    <a href="eclipse/index.html">Introduction</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="eclipse/install.html">Install</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="eclipse/usage.html">Usage</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="jibxws/index.html">JiBX/WS</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="axis2/index.html">Axis2 Usage</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="jibxota/index.html">JiBX/OTA</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="./schema-library/index.html">Schema Library</a>
                  </small>
                </div>
                      </div>
      

        </div>
      </td>
      <td>


<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="binding"></a>Running the compiler directly</h3>

<p>Once you have a binding definition, you need to compile the bindings into your
class files with the JiBX binding compiler. The easy way to do this is to run
the binding compiler straight from the supplied <i>jibx-bind.jar</i> file in the
<i>/lib</i> directory of the distribution. For instance, if the JiBX installation
is in <i>/home/dennis</i> and you're in the root of your application's class file
directory with a binding file named <i>binding.xml</i> you can just run:</p>

<div id="source"><pre>java -jar /home/dennis/jibx/lib/jibx-bind.jar binding.xml</pre></div>

<p>JiBX will automatically include the current directory in the class load path
when you run it this way. It'll need to have access to all the classes included
in the binding definition, though, along with any superclasses of those classes,
so you may need to include other class load root directories or jar files in the
classpath. Unfortunately, this won't work properly when you run the binding compiler
directly from the jar. You instead need to specify the compiler class directly,
and include the <i>jibx-bind.jar</i> in your classpath as follows (in a single
line, shown split here only for formatting):</p>

<div id="source"><pre>java -cp .:lib/support.jar:/home/dennis/jibx/lib/jibx-bind.jar
    org.jibx.binding.Compile binding.xml</pre></div>

<p>As when the binding compiler is run directly from the jar, you need to have the
<i>jibx-bind.jar</i> file in the same directory as the other jar files from the
<i>/lib</i> directory of the distribution for this to work correctly. Note that
this is the Unix/Linux version of the command line; if you're running Windows or other
DOS-based systems you'll need to reverse the slashs and use ';' instead of ':'
as a path separator character.</p>

<p>Without any options, the JiBX binding compiler won't print anything to the
console unless there's an error in compiling the bindings. If you want to see a
detailed list of classes modified or generated by the binding compiler you can
pass an option of <code>-v</code> at the start of the arguments. This will output
a listing of all classes included in the bindings, along with actual method
information for each class (the methods and classes added by JiBX are easy to
spot, since they all have names starting with &quot;JiBX&quot;).</p>

<p>If you just want to validate the modified or generated classes without a
detailed listing you can use an option of <code>-l</code>. This test-loads the
effected class files into the JVM as the binding compiler is running. If it
operates without an error you can be sure that the generated code obeys the rules
enforced by the JVM specification. It's normally not necessary to take this step,
but it serves as a good check if you encounter any class loading errors when
using the code modified by JiBX. Any error reported with this option indicates
a problem within the JiBX binding compiler operation. If this occurs you should
check the <a href="http://jira.codehaus.org/secure/BrowseProject.jspa?id=10410">Jira
issue tracking system</a> and create a new issue describing the circumstances of
the error if it's not a duplicate of an existing issue. You can also check the <a
href="http://www.jibx.org/status.html#problems">Status page</a> of the web site
first to see if there's already a fix for the problem.</p>

<p>You can rerun the binding compiler at any time, and <i><b>must</b></i> rerun
the binding compiler if you recompile any of the bound classes. If your class
files have not been recompiled and the bindings haven't changed since the last
time you ran the binding compiler it won't modify any of the classes. If you do
change either the class files or the binding
definitions only those classes effected by the change will be modified.</p>

</div>
<div class="h3">
<h3><a name="task"></a>Binding compiler Ant task</h3>

<p>If you're using Ant as a project build tool JiBX provides an even easier
way of running the binding compiler, by using a custom Ant task. To make use of
this in your Ant <i>build.xml</i> file you'll first need to add a custom task
definition like this (with the <i>jibx-lib</i> property set to the appropriate
path to the <i>lib</i> directory of your JiBX installation - but note that some
versions of Ant may not work properly if the JiBX installation path contains a
space character):</p>

<div id="source"><pre>  &lt;!-- JiBX binding compiler task definition --&gt;
  &lt;taskdef name="bind" classname="org.jibx.binding.ant.CompileTask">
    &lt;classpath>
      &lt;fileset dir="${jibx-lib}" includes="*.jar"/>
    &lt;/classpath>
  &lt;/taskdef>
</pre></div>

<p>Then you'll be able to invoke the binding compiler during the build process
like this:</p>

<div id="source"><pre>  &lt;!-- Run JiBX binding compiler --&gt;
  &lt;bind verbose=&quot;true&quot; load=&quot;true&quot; binding=&quot;binding.xml&quot;&gt;
    &lt;classpathset dir=&quot;classes&quot;/&gt;
  &lt;/bind&gt; 
</pre></div>

<p>One issue to note with the Ant task is that if you're using default values
you'll need to include the <i>jibx-run.jar</i> from the distribution in the
classpath passed when you invoke the task:</p>

<div id="source"><pre>  &lt;!-- Run JiBX binding compiler --&gt;
  &lt;bind verbose=&quot;true&quot; load="true" binding=&quot;binding.xml&quot;&gt;
    &lt;classpath>
      &lt;pathelement path="classes"/>
      &lt;pathelement location="${jibx-lib}/jibx-run.jar"/>
    &lt;/classpath>
  &lt;/bind&gt; 
</pre></div>

<p>Here's the full description of the attributes and nested elements supported
by the JiBX Ant task:</p>
      <table cellpadding="3" cellspacing="2" border="1" width="100%">
		  <tr class="b">
		    <th>Attribute</th>
		    <th>Description</th>
		    <th>Required</th>
		  </tr>
		  <tr class="a">
		    <td valign="top">verbose</td>
		    <td valign="top">Flag for JiBX compiler output.</td>
		    <td valign="top" align="center">No</td>
		  </tr>
		  
		   <tr class="b">
		    <td valign="top">load</td>
		    <td valign="top">Flag to specify whether or not to load generated files.</td>
		    <td valign="top" align="center">No</td>
		  </tr>
		
		   <tr class="a">
		    <td valign="top">binding</td>
		    <td valign="top">Single binding file</td>
		    <td valign="top" align="center">No*</td>
		  </tr>
		
		   <tr class="b">
		    <td valign="top">bindingfileset</td>
		    <td valign="top">FileSet of binding files</td>
		    <td valign="top" align="center">No*</td>
		  </tr>
		
		   <tr class="a">
		    <td valign="top">classpathset</td>
		    <td valign="top">FileSet for bound class files</td>
		    <td valign="top" align="center">Yes</td>
		  </tr>
      
      <tr><td colspan="3">* - either <i>binding</i> or <i>bindingfileset</i>
      must be supplied</td></tr>
		</table>

</div>
<div class="h3">
<h3><a name="maven2">Maven plugin</h3>

<p>The <a href="./jibx-maven-plugin/index.html">Maven JiBX
Plugin</a> supports running the JiBX binding compiler as part of your Maven
project. See the linked page for details.</p>

</div>
<div class="h3">
<h3><a name="eclipse-use"></a>Binding with Eclipse</h3>

<p>If you're using Eclipse as your IDE, the <a href="eclipse/index.html">Eclipse plugin</a> lets
you easily integrate the JiBX binding step into your development. Note that the plugin
typically lags in support for the latest version of JiBX, though, so if you need to use
the latest JiBX code you may be better off using an alternative approach (such as described
in the <a href="#ide-use">Binding with other IDEs</a> topic, below). See the
<a href="eclipse/index.html">Eclipse plugin</a> page for full details of the plugin.</p>

</div>
<div class="h3">
<h3><a name="intellij-use"></a>Binding with IntelliJ IDEA</h3>

<p>If you're using IntelliJ IDEA as your IDE, the
<a href="http://plugins.intellij.net/plugin/?id=239">IDEA JiBX Plugin</a> will
integrate the binding step into your development, including binding validation
support. See the linked page for details.</p>

</div>
<div class="h3">
<h3><a name="ide-use"></a>Binding with other IDEs</h3>

<p>Running the JiBX binding compiler can be a problem when using IDEs without
plugin support, since
IDEs generally assume that they have total control over the compiled class
files. If the IDE overwrites a class file which has been modified by the JiBX
binding compiler the binding will no longer be usable. The solution is just to
run the binding compiler again - but having to do that manually every time the
IDE modifies the files can be painful, especially if the binding compiler cannot
be run from inside the IDE.</p>

<p>Fortunately, most modern IDEs offer support for using Ant builds. If you
include an Ant <i>build.xml</i> as part of your project, you can generally run a
target within that build easily from your IDE. This technique works especially
well if you set up a separate Ant build file with the binding compiler executed
by the default target. There's a sample of this approach in the <i>starter</i>
example provided in the JiBX distribution, which includes both a normal Ant
<i>build.xml</i> with all the steps needed to build the project, and a separate
<i>build-binding.xml</i> Ant build file intended for easy use of the binding
compiler within an IDE. The remainder of this section uses the starter project
to illustrate running the binding compiler through Ant within Eclipse.</p>

<div class="h4">
<h4>Running an Ant target within Eclipse</h4>
<p>It's reasonably easy to run an Ant target in a <i>build.xml</i> file within
an Eclipse project. You can right-click on the <i>build.xml</i> file to get a
context menu, select the <b>Run As</b> item, and the <b>Ant Build...</b> (click on this
image for a full-size image):.</p>
<a href="./images/eclipse-run1.gif"><img src="./images/eclipse-run1-small.gif" width="490" height="383" alt="Run Ant build target from Eclipse"></a>

<p>This brings up a dialog box, which allows you to select the specific build
target to be executed, as shown below:</p>
<a href="./images/eclipse-run2.gif"><img src="./images/eclipse-run2-small.gif" width="490" height="383" alt="Select Ant build target to be executed"></a>

<p>You can also use a separate Ant build for the JiBX binding compiler step,
making the binding compiler target the default target for the build. This makes
it simpler to run the target from Eclipse, since you can avoid the target
selection dialog step from the above sequence. Just select <b>Run As</b> and then
<b>Ant Build</b> from the context menu for the build file:</p>
<a href="./images/eclipse-run3.gif"><img src="./images/eclipse-run3-small.gif" width="490" height="384" alt="Run default Ant build target from Eclipse"></a>

<p>This approach is flexible, in that you can run the binding compiler any time
you want. It does require you to take a manual action to trigger the execution,
but remember that you only need to run the binding compiler when you're actually
going to use the bindings (as part of your debugging, for instance).</p>

</div>

<div class="h4">
<h4>Defining a build step in Eclipse</h4>
<p>Besides running an Ant target on command, you can make the execution of one
or more targets from an Ant build part of the normal build of your project. To
do this, go to the project properties (from the right-click context menu on the
project name, or from the <b>File</b> menu with the project name selected) and select
the <b>Builders</b> pane. From this you can then add an Ant build as a new
builder for the project:</p>
<a href="./images/eclipse-build1.gif"><img src="./images/eclipse-build1-small.gif" width="490" height="381" alt="Add an Ant builder to a project"></a>

<p>Just clicking <b>OK</b> brings up the builder properties dialog. On this dialog
you can change the name of the builder from the default, and then click on
<b>Browse Workspace...</b> under the <b>Buildfile</b> path to bring up a selection
dialog:</p>
<a href="./images/eclipse-build2.gif"><img src="./images/eclipse-build2-small.gif" width="490" height="383" alt="Select the Ant build file"></a>

<p>By default, an Ant builder will only run the default target for the
build. If running the binding compiler is not the default target for the build,
you can go into the <b>Targets</b> tab of the dialog to change the target to be run
by the builder:</p>
<a href="./images/eclipse-build3.gif"><img src="./images/eclipse-build3-small.gif" width="490" height="384" alt="Select the Ant targets to be run"></a>

<p>This step needs to be done for each form of activation of the builder (the
different areas within the <b>Targets</b> tab). By setting the appropriate
target for <b>After a "Clean"</b> the builder will be run everytime you execute
a <b>Clean...</b> build (from the <b>Project</b> menu). This is especially
useful for working on projects with other developers, where a clean build is
</p>

<p>You can also set the target for <b>Auto Build</b> in order to run the binding
compiler step every time a file is automatically recompiled by Eclipse, but this
setting can be very intrusive. Since you only need to run the binding compiler
when one of the classes included in the binding is modified, it's generally
easier to just run the binding Ant build directly (using the <b>Run As</b>
technique, described in the previous section) as needed, while using the builder
approach to apply the binding on clean builds of the project.</p>

</div>

</div>
</div>
</div>


      </td>
    </tr>
  </tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
  <tbody>
    <tr>
      <td> &copy; 2003-2011, Dennis M. Sosnoski (<a href="http://www.sosnoski.co.nz">Sosnoski Software Associates Ltd</a>).
      Licensed to the JiBX Project for free distribution and use. </td>
    </tr>
  </tbody>
</table>
</div>
<br>
</body>
</html>