4632N/A." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
4632N/A." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4632N/A."
4632N/A." This code is free software; you can redistribute it and/or modify it
4632N/A." under the terms of the GNU General Public License version 2 only, as
4632N/A." published by the Free Software Foundation.
4632N/A."
4632N/A." This code is distributed in the hope that it will be useful, but WITHOUT
4632N/A." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4632N/A." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4632N/A." version 2 for more details (a copy is included in the LICENSE file that
4632N/A." accompanied this code).
4632N/A."
4632N/A." You should have received a copy of the GNU General Public License version
4632N/A." 2 along with this work; if not, write to the Free Software Foundation,
4632N/A." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
4632N/A."
4632N/A." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
4632N/A." or visit www.oracle.com if you need additional information or have any
4632N/A." questions.
4632N/A."
4632N/A.TH xjc 1 "10 May 2011"
4632N/A
4632N/A.LP
4632N/A.SH "Name"
4632N/Axjc \- Java(TM) Architecture for XML Binding
4632N/A.br
4632N/ABinding Compiler
4632N/A.LP
4632N/A.LP
4632N/A\f3Specification Version:\fP 2.1
4632N/A.br
4632N/A\f3Reference Implementation (RI) Version:\fP 2.1.3
4632N/A.LP
4632N/A.SH "Launching xjc"
4632N/A.LP
4632N/A.LP
4632N/AThe binding compiler can be launched using the appropriate \f2xjc\fP shell script in the \f2bin\fP directory for your platform. We also provide an Ant task to run the binding complier \- see the instructions for
4632N/A.na
4632N/A\f2using the XJC Ant task\fP @
4632N/A.fi
4632N/Ahttps://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html.
4632N/A.LP
4632N/A.LP
4632N/A\f2% xjc \-help\fP
4632N/A.LP
4632N/A.SS
4632N/AOutput
4632N/A.LP
4632N/A.nf
4632N/A\f3
4632N/A.fl
4632N/AUsage: xjc [\-options ...] <schema file/URL/dir/jar> ... [\-b <bindinfo>] ...
4632N/A.fl
4632N/AIf dir is specified, all schema files in it will be compiled.
4632N/A.fl
4632N/AIf jar is specified, /META\-INF/sun\-jaxb.episode binding file will be compiled.
4632N/A.fl
4632N/AOptions:
4632N/A.fl
4632N/A \-nv : do not perform strict validation of the input schema(s)
4632N/A.fl
4632N/A \-extension : allow vendor extensions \- do not strictly follow the Compatibility Rules and App E.2 from the JAXB Spec
4632N/A.fl
4632N/A \-b <file/dir> : specify external bindings files (each <file> must have its own \-b); if a directory is given, **/*.xjb is searched
4632N/A.fl
4632N/A \-d <dir> : generated files will go into this directory
4632N/A.fl
4632N/A \-p <pkg> : specifies the target package
4632N/A.fl
4632N/A \-httpproxy <proxy> : set HTTP/HTTPS proxy; format is [user[:password]@]proxyHost:proxyPort
4632N/A.fl
4632N/A \-httpproxyfile <f> : works like \-httpproxy but takes the argument in a file to protect password
4632N/A.fl
4632N/A \-classpath <arg> : specify where to find user class files
4632N/A.fl
4632N/A \-catalog <file> : specify catalog files to resolve external entity references; support TR9401, XCatalog, and OASIS XML Catalog format
4632N/A.fl
4632N/A \-readOnly : generated files will be in read\-only mode
4632N/A.fl
4632N/A \-npa : suppress generation of package level annotations (**/package\-info.java)
4632N/A.fl
4632N/A \-no\-header : suppress generation of a file header with timestamp
4632N/A.fl
4632N/A \-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features
4632N/A.fl
4632N/A \-xmlschema : treat input as W3C XML Schema (default)
4632N/A.fl
4632N/A \-relaxng : treat input as RELAX NG (experimental,unsupported)
4632N/A.fl
4632N/A \-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported)
4632N/A.fl
4632N/A \-dtd : treat input as XML DTD (experimental,unsupported)
4632N/A.fl
4632N/A \-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported)
4632N/A.fl
4632N/A \-verbose : be extra verbose
4632N/A.fl
4632N/A \-quiet : suppress compiler output
4632N/A.fl
4632N/A \-help : display this help message
4632N/A.fl
4632N/A \-version : display version information
4632N/A.fl
4632N/A
4632N/A.fl
4632N/A
4632N/A.fl
4632N/AExtensions:
4632N/A.fl
4632N/A \-Xlocator : enable source location support for generated code
4632N/A.fl
4632N/A \-Xsync\-methods : generate accessor methods with the 'synchronized' keyword
4632N/A.fl
4632N/A \-mark\-generated : mark the generated code as @javax.annotation.Generated
4632N/A.fl
4632N/A \-episode <FILE> : generate the episode file for separate compilation
4632N/A.fl
4632N/A\fP
4632N/A.fi
4632N/A
4632N/A.LP
4632N/A.SH "OPTIONS"
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/A\-nv
4632N/ABy default, the XJC binding compiler performs strict validation of the source schema before processing it. Use this option to disable strict schema validation. This does not mean that the binding compiler will not perform any validation, it simply means that it will perform less\-strict validation.
4632N/A.TP 3
4632N/A\-extension
4632N/ABy default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification. Appendix E.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1.0. In some cases, you may be allowed to use them in the "\-extension" mode enabled by this switch. In the default (strict) mode, you are also limited to using only the binding customizations defined in the specification. By using the "\-extension" switch, you will be allowed to use the JAXB Vendor Extensions
4632N/A.TP 3
4632N/A\-b <file>
4632N/ASpecify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files: \f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP
4632N/A.br
4632N/A\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP In addition, the ordering of the schema files and binding files on the command line does not matter.
4632N/A.TP 3
4632N/A\-d <dir>
4632N/ABy default, the XJC binding compiler will generate the Java content classes in the current directory. Use this option to specify an alternate output directory. The output directory must already exist, the XJC binding compiler will not create it for you.
4632N/A.TP 3
4632N/A\-p <pkg>
4632N/ASpecifying a target package via this command\-line option overrides any binding customization for package name and the default package name algorithm defined in the specification.
4632N/A.TP 3
4632N/A\-httpproxy <proxy>
4632N/ASpecify the HTTP/HTTPS proxy. The format is [user[:password]@]proxyHost[:proxyPort]. The old \f2\-host\fP and \f2\-port\fP are still supported by the RI for backwards compatibility, but they have been deprecated. Note that the password specified with this option is an argument that is visible to other users who use the \f2top\fP command, for example. For greater security, use \f2\-httpproxyfile\fP, below.
4632N/A.TP 3
4632N/A\-httpproxyfile <file>
4632N/ASpecify the HTTP/HTTPS proxy using a file. Same format as above, but the password specified in the file is not visible to other users.
4632N/A.TP 3
4632N/A\-classpath <arg>
4632N/ASpecify where to find client application class files used by the \f2<jxb:javaType>\fP and \f2<xjc:superClass>\fP customizations.
4632N/A.TP 3
4632N/A\-catalog <file>
4632N/ASpecify catalog files to resolve external entity references. Supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the XML Entity and URI Resolvers document or the \f2catalog\-resolver\fP sample application.
4632N/A.TP 3
4632N/A\-readOnly
4632N/ABy default, the XJC binding compiler does not write\-protect the Java source files it generates. Use this option to force the XJC binding compiler to mark the generated Java sources read\-only.
4632N/A.TP 3
4632N/A\-npa
4632N/ASupress the generation of package level annotations into **/package\-info.java. Using this switch causes the generated code to internalize those annotations into the other generated classes.
4632N/A.TP 3
4632N/A\-no\-header
4632N/ASupress the generation of a file header comment that includes some note and timestamp. Using this makes the generated code more diff\-friendly.
4632N/A.TP 3
4632N/A\-target 2.0
4632N/AAvoid generating code that relies on any JAXB 2.1 features. This will allow the generated code to run with JAXB 2.0 runtime (such as JavaSE 6.)
4632N/A.TP 3
4632N/A\-xmlschema
4632N/ATreat input schemas as W3C XML Schema (default). If you do not specify this switch, your input schemas will be treated as W3C XML Schema.
4632N/A.TP 3
4632N/A\-relaxng
4632N/ATreat input schemas as RELAX NG (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension.
4632N/A.TP 3
4632N/A\-relaxng\-compact
4632N/ATreat input schemas as RELAX NG compact syntax(experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension.
4632N/A.TP 3
4632N/A\-dtd
4632N/ATreat input schemas as XML DTD (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension.
4632N/A.TP 3
4632N/A\-wsdl
4632N/ATreat input as WSDL and compile schemas inside it (experimental,unsupported).
4632N/A.TP 3
4632N/A\-quiet
4632N/ASuppress compiler output, such as progress information and warnings.
4632N/A.TP 3
4632N/A\-verbose
4632N/ABe extra verbose, such as printing informational messages or displaying stack traces upon some errors.
4632N/A.TP 3
4632N/A\-help
4632N/ADisplay a brief summary of the compiler switches.
4632N/A.TP 3
4632N/A\-version
4632N/ADisplay the compiler version information.
4632N/A.TP 3
4632N/A<schema file/URL/dir>
4632N/ASpecify one or more schema files to compile. If you specify a directory, then xjc will scan it for all schema files and compile them.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SS
4632N/ANon\-Standard Command Line Options
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/A\-Xlocator
4632N/ACauses the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling.
4632N/A.TP 3
4632N/A\-Xsync\-methods
4632N/ACauses all of the generated method signatures to include the \f2synchronized\fP keyword.
4632N/A.TP 3
4632N/A\-mark\-generated
4632N/AMark the generated code with the annotation \f2@javax.annotation.Generated\fP.
4632N/A.TP 3
4632N/A\-episode <file>
4632N/AGenerate the specified episode file for separate compilation.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SS
4632N/ADeprecated and Removed Command Line Options
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/A\-host & \-port
4632N/AThese options have been deprecated and replaced with the \f3\-httpproxy\fP option. For backwards compatibility, we will continue to support these options, but they will no longer be documented and may be removed from future releases.
4632N/A.TP 3
4632N/A\-use\-runtime
4632N/ASince the JAXB 2.0 specification has defined a portable runtime, it is no longer necessary for the JAXB RI to generate **/impl/runtime packages. Therefore, this switch is obsolete and has been removed.
4632N/A.TP 3
4632N/A\-source
4632N/AThe \-source compatibility switch was introduced in the first JAXB 2.0 Early Access release. We have decided to remove this switch from future releases of JAXB 2.0. If you need to generate 1.0.x code, please use an installation of the 1.0.x codebase.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SS
4632N/ACompiler Restrictions
4632N/A.LP
4632N/A.LP
4632N/AIn general, it is safest to compile all related schemas as a single unit with the same binding compiler switches.
4632N/A.LP
4632N/A.LP
4632N/APlease keep the following list of restrictions in mind when running xjc. Most of these issues only apply when compiling multiple schemas with multiple invocations of xjc.
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 2
4632N/Ao
4632N/ATo compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind:
4632N/A.RS 3
4632N/A.TP 3
4632N/A1.
4632N/AThe "\f2\-p\fP" command line option takes the highest precedence.
4632N/A.TP 3
4632N/A2.
4632N/A<\f2jaxb:package\fP> customization
4632N/A.TP 3
4632N/A3.
4632N/AIf \f2targetNamespace\fP is declared, apply \f2targetNamespace\fP \-> Java package name algorithm defined in the specification.
4632N/A.TP 3
4632N/A4.
4632N/AIf no \f2targetNamespace\fP is declared, use a hardcoded package named "generated".
4632N/A.RE
4632N/A.TP 2
4632N/Ao
4632N/AIt is not legal to have more than one <\f2jaxb:schemaBindings\fP> per namespace, so it is impossible to have two schemas in the same target namespace compiled into different Java packages.
4632N/A.TP 2
4632N/Ao
4632N/AAll schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time \- they cannot be compiled independently and work as expected.
4632N/A.TP 2
4632N/Ao
4632N/AElement substitution groups spread across multiple schema files must be compiled at the same time.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SH "See Also"
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 2
4632N/Ao
4632N/ARunning the binding compiler (XJC): [
4632N/A.na
4632N/A\f2command\-line instructions\fP @
4632N/A.fi
4632N/Ahttps://jaxb.dev.java.net/nonav/2.1.3/docs/xjc.html,
4632N/A.na
4632N/A\f2using the XJC Ant task\fP @
4632N/A.fi
4632N/Ahttps://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html]
4632N/A.TP 2
4632N/Ao
4632N/A.na
4632N/A\f2Java Architecture for XML Binding (JAXB)\fP @
4632N/A.fi
4632N/Ahttp://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A