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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Generation Tools: Binding Generator Options</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>Generation Tools: Binding Generator Options</h1>
</td>
<td>
<div align="right" id="login"><a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=69358&type=5"
width="210" height="62" border="0" alt="SourceForge.net Logo"></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="http://wiki.jibx.org">Wiki</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="../flexibility.html">Flexibility</a>
</small>
</div>
<div>
<small>
<a href="../performance.html">Performance</a>
</small>
</div>
<div>
<small>
<a href="../clean-code.html">Clean code</a>
</small>
</div>
</div>
<div>
<small>
<a href="../status.html">News and Status</a>
</small>
</div>
<div>
<small>
<a href="../bugs.html">Bugs</a>
</small>
</div>
<div>
<small>
<a href="../start.html">Getting Started</a>
</small>
<div>
<small>
<a href="../tutorial/binding-tutorial.html">Binding Tutorial</a>
</small>
<div>
<small>
<a href="../tutorial/binding-start.html">A basic binding</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-extras.html">Binding extras</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-collects.html">Collections</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-advanced.html">Advanced binding</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-extend.html">Method hooks</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-custom.html">Custom code</a>
</small>
</div>
</div>
<div>
<small>
<a href="../bindcomp.html">Binding Compiler</a>
</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">JiBX Extras</a>
</small>
</div>
<div>
<small>
<a href="../building.html">Building JiBX</a>
</small>
</div>
</div>
<div>
<small>
<a href="../schema.html">Schema Compatibility</a>
</small>
</div>
<div>
<small>
<a href="../mail-lists.html">Mailing Lists</a>
</small>
</div>
<div>
<small>
<a href="../faq.html">FAQ</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>
<strong>Binding Definition</strong>
<div>
<small>
<a href="../details/binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="../details/contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="../details/conversions.html">Conversions</a>
</small>
</div>
<div>
<small>
<a href="../details/xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="../details/binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="../details/include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="../details/format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="../details/namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="../details/mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="../details/value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="../details/structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="../details/collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="../details/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="index.html">Generator Tools</a>
</small>
<div>
<small>
<a href="index.html">Introduction</a>
</small>
</div>
<div>
<small>
<a href="bindgen.html">Binding Generator</a>
</small>
<div>
<small>
<a href="bind-example.html">Example</a>
</small>
</div>
<div>
<small>
<span class="menu-selection">Options</span>
</small>
</div>
</div>
<div>
<small>
<a href="schemagen.html">Schema Generator</a>
</small>
<div>
<small>
<a href="schema-example.html">Example</a>
</small>
</div>
<div>
<small>
<a href="schemaopts.html">Options</a>
</small>
</div>
</div>
</div>
<div>
<small>
<a href="../jibxsoap/index.html">JibxSoap</a>
</small>
<div>
<small>
<a href="../jibxsoap/index.html">Introduction</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/server.html">Server</a>
</small>
<div>
<small>
<a href="../jibxsoap/server-config.html">Configuration</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/service-def.html">Definition</a>
</small>
</div>
</div>
<div>
<small>
<a href="../jibxsoap/client.html">Client</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/example.html">Example</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/install.html">Install</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/status.html">Status</a>
</small>
</div>
<div>
<small>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/./api/index.html">JavaDocs</a>
</small>
</div>
</div>
<div>
<small>
<a href="../siteamatic/index.html">SiteAMatic</a>
</small>
</div>
<div>
<small>
<a href="../xsd2jibx/index.html">Xsd2Jibx</a>
</small>
</div>
<div>
<small>
<a href="../plugin/index.html">Eclipse Plugin</a>
</small>
</div>
</div>
</div>
</td>
<td>
<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="options">Generation Tools: Binding Generator Options</a></h3>
<p>Many options can be specified on the command line to customize the behavior
of the binding generator. Each option is indicated by a hyphen character ('-')
followed by a character that identifies the option. Most options require
additional information, and for these the next command line argument following
the option supplies the necessary information. All command line options must be
given before the list of classes to be included in the generated binding. Here's
the complete list of options:</p>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<th>Option</th>
<th>Description</th>
<th>Repeatable</th>
</tr>
<tr class="a">
<td valign="top">-a arg</td>
<td valign="top"><b>Abstract base class</b><br/>The argument following
the flag is the fully-qualified name of a class
to be treated as an abstract base class, where references to this class
will actually use a subclass instance at runtime.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr class="b">
<td valign="top">-b arg</td>
<td valign="top"><b>Bean property class definition</b><br/>The argument
following the flag is of the form <i>class-name=pname1,pname2,...</i>,
where <i>class-name</i> is the fully-qualified name of a class to be
treated as a Java Bean and <i>pname#</i> is a property name to be
accessed using getPname# and setPname# methods.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr class="a">
<td valign="top">-c arg</td>
<td valign="top"><b>Custom mapped class</b><br/>The argument following
the flag is of the form <i>class-name=handler-class-name</i>, where
<i>class-name</i> is the fully-qualified name of a class to be mapped,
and <i>handler-class-name</i> is the fully qualified class name of the
custom marshaller/unmarshaller class to be used for this mapping.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr class="b">
<td valign="top">-e arg</td>
<td valign="top"><b>Enumeration class definition</b><br/>The argument
following the flag is of the form <i>class-name[=deser-meth]</i>, where
<i>class-name</i> is the fully-qualified name of a class to be treated
as a type-safe enumeration. If this class name is given by itself the
enumeration class must define a static method <i>getCName()</i>,
where <i>CName</i> is the simple name of the class (without any package
information), which takes a single <code>java.lang.String</code>
parameter representing a text value for the enumeration and returns an
instance of the class. If the optional <i>=deser-meth</i> version of the
argument is used the specified <i>deser-meth</i> must be a static method
of this type. The <i>deser-meth</i> can be given with a leading package
and class name; if given as a simple method name it must be defined by
the type-safe enumeration class itself. The enumeration class must
always return an appropriate text representation for a value from the
<code>toString()</code> method, since this is how the enumeration values
are serialized during marshalling.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr class="a">
<td valign="top">-f arg</td>
<td valign="top"><b>Binding file path</b><br/>The argument following the
flag is the path to be used for the generated binding definition file.
If not specified this defaults to <i>binding.xml</i>.</td>
<td valign="top" align="center">No</td>
</tr>
<tr class="b">
<td valign="top">-i arg</td>
<td valign="top"><b>Ignored class</b><br/>The argument following
the flag is the fully-qualified name of a class to be ignored in the
constructed binding. This allows you to skip classes which require
special handling beyond the limits of the binding generator's
customizations, though you'll generally need to modify the generated
binding to deal with these classes before you can use it.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr class="a">
<td valign="top">-m</td>
<td valign="top"><b>Mixed case names</b><br/>This option changes the
form of generated element and attribute names to use mixed (camel) case,
rather than the default hyphenated names.</td>
<td valign="top" align="center">No</td>
</tr>
<tr class="b">
<td valign="top">-n arg</td>
<td valign="top"><b>Namespace URI</b><br/>The argument following
the flag is the URI of the namespace to be used for all generated
element definitions. Attributes in the generated binding never use a
namespace.</td>
<td valign="top" align="center">No</td>
</tr>
<tr class="a">
<td valign="top">-p arg</td>
<td valign="top"><b>Class load path</b><br/>The argument following the
flag is a path component to be used for loading the classes to be
included in the generated binding definition. By default the current
directory is used in the class load path, along with all entries from
the classpath used in running the binding generation tool.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr class="b">
<td valign="top">-v</td>
<td valign="top"><b>Verbose</b><br/>This option enables printing of
detailed information during the execution of the binding generation
tool, useful for isolating problems with the tool.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
</div>
</div>
</div>
</td>
</tr>
</tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
<tbody>
<tr>
<td> © 2003-2005, Dennis M. Sosnoski (<a href="http://www.sosnoski.com">Sosnoski Software Solutions, Inc.</a>).
Licensed to the JiBX Project for free distribution and use. </td>
</tr>
</tbody>
</table>
</div>
<br>
</body>
</html>
|