view src/solaris/doc/sun/man/man1/ja/xjc.1 @ 4106:d5a7ed4e72a4

6546713: link the word (optional) in exception specifications to the text which provides explanation and context. Reviewed-by: dholmes, dl
author mduigou
date Wed, 20 Apr 2011 17:20:00 -0700
parents 00cd9dc3c2b5
children 02473ee63688
line wrap: on
line source
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
." under the terms of the GNU General Public License version 2 only, as
." published by the Free Software Foundation.
."
." This code is distributed in the hope that it will be useful, but WITHOUT
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
." version 2 for more details (a copy is included in the LICENSE file that
." accompanied this code).
."
." You should have received a copy of the GNU General Public License version
." 2 along with this work; if not, write to the Free Software Foundation,
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
."
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH xjc 1 "02 Jun 2010"

.LP
.ad c
.SH "名前"
xjc \- XML バインドのための Java(TM) アーキテクチャー
.br
バインディングコンパイラ 
.LP
\f3仕様バージョン:\fP 2.1
.br
\f3リファレンス実装 (RI) バージョン:\fP 2.1.3 .ad l

.LP
.SH "xjc の起動"
.LP
.LP
バインディングコンパイラを起動するには、使用するプラットフォームに応じた \f2bin\fP ディレクトリ内の \f2xjc\fP シェルスクリプトを使用します。また、バインディングコンパイラを実行するための Ant タスクも用意されています。 
.na
\f2xjc を Ant とともに使用する\fP @
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.htmlための手順を参照してください。
.LP
.RS 3

.LP
.LP
\f2% xjc \-help\fP
.LP
.RE
\f3出力\fP
.LP
.RS 3

.LP
.nf
\f3
.fl
Usage: xjc [\-options ...] <schema_file/URL/dir> ... [\-b <bindinfo>] ...
.fl
Options:
.fl
 \-nv                  : do not perform strict validation of the input schema(s)
.fl
 \-extension           : allow vendor extensions \- do not strictly follow the
.fl
                        Compatibility Rules and App E.2 from the JAXB Spec
.fl
 \-b <file/dir>        : specify external bindings files (each <file> must have its own \-b)
.fl
                        If a directory is given, **/*.xjb is searched
.fl
 \-d <dir>             : generated files will go into this directory
.fl
 \-p <pkg>             : specifies the target package
.fl
 \-httpproxy <proxy>   : set HTTP/HTTPS proxy. Format is [user[:password]@]proxyHost:proxyPort
.fl
 \-httpproxyfile <file>: set the proxy string (same format as above).
.fl
 \-classpath <arg>     : specify where to find user class files
.fl
 \-catalog <file>      : specify catalog files to resolve external entity references
.fl
                        support TR9401, XCatalog, and OASIS XML Catalog format.
.fl
 \-readOnly            : generated files will be in read\-only mode
.fl
 \-npa                 : suppress generation of package level annotations (**/package\-info.java)
.fl
 \-no\-header           : suppress generation of a file header with timestamp
.fl
 \-target 2.0          : behave like XJC 2.0 and generate code that doesnt use any 2.1 features.
.fl
 \-xmlschema           : treat input as W3C XML Schema (default)
.fl
 \-relaxng             : treat input as RELAX NG (experimental,unsupported)
.fl
 \-relaxng\-compact     : treat input as RELAX NG compact syntax (experimental,unsupported)
.fl
 \-dtd                 : treat input as XML DTD (experimental,unsupported)
.fl
 \-wsdl                : treat input as WSDL and compile schemas inside it (experimental,unsupported)
.fl
 \-verbose             : be extra verbose
.fl
 \-quiet               : suppress compiler output
.fl
 \-help                : display this help message
.fl
 \-version             : display version information
.fl
\fP
.fi
.RE

.LP
.SH "オプション"
.LP

.LP
.RS 3
.TP 3
\-nv 
デフォルトでは、XJC バインディングコンパイラは、ソーススキーマを処理する前に厳密な検証を実行します。このオプションを使用すると、厳密なスキーマ検証を無効にします。これは、バインディングコンパイラが検証を一切実行しないということではありません。 より厳密でない検証を実行するということです。 
.TP 3
\-extension 
デフォルトでは、XJC バインディングコンパイラは、JAXB 仕様の「Compatibility」の章で説明されている規則を厳密に強制します。付録 E.2 には、JAXB v1.0 で完全にはサポートされていない一連の W3C XML スキーマ機能が定義されています。 場合によっては、このスイッチで有効になる「\-extension」モードでそれらの機能が使用できるかもしれません。また、デフォルトの厳密なモードでは、仕様に定義されているバインディングカスタマイズのみが使用できます。「\-extension」スイッチを指定すれば、JAXB Vendor Extension を使用できます。 
.TP 3
\-b <file> 
処理する外部バインディングファイルを 1 つまたは複数指定します。(バインディングファイルごとに「\f2\-b\fP」スイッチを指定する必要があります。)外部バインディングファイルの構文は非常に柔軟です。複数のスキーマのカスタマイズが含まれる 1 つのバインディングファイルを使用したり、それらのカスタマイズを複数のバインディングファイルに分割したりできます。 次に例を示します。 
.RS 3

.LP
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP
.br
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP
.RE
また、コマンド行にスキーマファイルとバインディングファイルを指定する順番は任意です。 
.TP 3
\-d <dir> 
デフォルトでは、XJC バインディングコンパイラは、Java コンテンツクラスを現在のディレクトリに生成します。このオプションを使用すると、代替出力ディレクトリを指定できます。出力ディレクトリはあらかじめ存在している必要があります。 XJC バインディングコンパイラは、このディレクトリを自動的に作成しません。 
.TP 3
\-p <pkg> 
このコマンド行オプション経由でターゲットパッケージを指定した場合、その指定内容は、パッケージ名に対するすべてのバインディングカスタマイズや、仕様で規定されているデフォルトのパッケージ名アルゴリズムよりも優先されます。 
.TP 3
\-httpproxy <proxy> 
HTTP/HTTPS プロキシを指定します。形式は [user[:password]@]proxyHost[:proxyPort] です。従来の \f2\-host\fP および \f2\-port\fP は、下位互換性のためにリファレンス実装でもサポートされていますが、推奨されなくなりました。このオプションで指定されたパスワードは、\f2top\fP コマンドを使用するユーザーなど、ほかのユーザーが表示できる引数であることに注意してください。セキュリティーを高めるには、次の \f2\-httpproxyfile\fP を使用してください。 
.TP 3
\-httpproxyfile <file> 
HTTP/HTTPS プロキシをファイル経由で指定します。形式は上記と同じですが、このファイル内に指定されたパスワードをほかのユーザーが表示することはできません。 
.TP 3
\-classpath <arg> 
\f2<jxb:javaType>\fP および \f2<xjc:superClass>\fP カスタマイズが使用するクライアントアプリケーションのクラスファイルの検索場所を指定します。 
.TP 3
\-catalog <file> 
外部エンティティー参照を解決するカタログファイルを指定します。TR9401、XCatalog、および OASIS XML Catalog 形式がサポートされます。詳細は、『XML Entity and URI Resolvers』ドキュメントを参照するか、\f2カタログリゾルバ\fPのサンプルアプリケーションを調べてください。 
.TP 3
\-readOnly 
デフォルトでは、XJC バインディングコンパイラは、生成する Java ソースファイルを書き込みから保護しません。このオプションを使用すると、XJC バインディングコンパイラは生成される Java ソースを強制的に読み取り専用にします。 
.TP 3
\-npa 
パッケージレベルの注釈を **/package\-info.java に生成することを抑制します。このスイッチを使用して生成するコードでは、これらの注釈がほかの生成済みクラスに内部化されます。 
.TP 3
\-no\-header 
多少のメモとタイムスタンプを含むファイルヘッダーコメントの生成を抑制します。このオプションを使用すると、生成されたコードがわかりにくくなります。 
.TP 3
\-target 2.0 
なんらかの JAXB 2.1 機能に依存するコードを生成しないようにします。これにより、生成されたコードを JAXB 2.0 ランタイム (JavaSE 6 など) で実行できます。 
.TP 3
\-xmlschema 
入力スキーマを W3C XML スキーマ (デフォルト) と見なします。このスイッチを指定しなくても、入力スキーマは W3C XML スキーマと見なされます。 
.TP 3
\-relaxng 
入力スキーマを RELAX NG として扱います (試験的、未サポート)。RELAX NG スキーマのサポートは JAXB Vendor Extension として提供されています。 
.TP 3
\-relaxng\-compact 
入力スキーマを RELAX NG 圧縮構文として処理します (試験的、未サポート)。RELAX NG スキーマのサポートは JAXB Vendor Extension として提供されています。 
.TP 3
\-dtd 
入力スキーマを XML DTD として扱います (試験的、未サポート)。RELAX NG スキーマのサポートは JAXB Vendor Extension として提供されています。 
.TP 3
\-wsdl 
入力を WSDL として扱い、その内部のスキーマをコンパイルします (試験的、未サポート)。 
.TP 3
\-quiet 
進捗情報や警告など、コンパイラの出力を抑制します。 
.TP 3
\-verbose 
情報メッセージを出力したり特定のエラー発生時にスタックトレースを表示したりするなど、極めて冗長になります。 
.TP 3
\-help 
コンパイラスイッチの概要を表示します。 
.TP 3
\-version 
コンパイラのバージョン情報を表示します。 
.TP 3
<schema file/URL/dir> 
コンパイル対象となる 1 つまたは複数のスキーマファイルを指定します。ユーザーがディレクトリを指定した場合、xjc はそのディレクトリを走査し、そこで見つかったすべてのスキーマファイルをコンパイルします。 
.RE
.SS 
非推奨コマンド行オプションおよび削除されたコマンド行オプションの概要
.LP
.RS 3

.LP
.RS 3
.TP 3
\-host & \-port 
これらのオプションは非推奨となり、\f3\-httpproxy\fP オプションで置き換えられました。これらのオプションは、下位互換性を確保する目的で引き続きサポートされますが、ドキュメントには記載されず、将来のリリースで削除される可能性もあります。 
.TP 3
\-use\-runtime 
JAXB 2.0 仕様で移植性のあるランタイムが規定されたため、JAXB RI が **/impl/runtime パッケージを生成する必要がなくなりました。このため、このスイッチは不要となり、削除されました。 
.TP 3
\-source 
\-source 互換性スイッチは、JAXB 2.0 の最初の Early Access 版で導入されました。このスイッチは、JAXB 2.0 の今後のリリースから削除されることになりました。1.0.x コードを生成する必要がある場合には、1.0.x コードベースのインストールを使用してください。 
.TP 3
\-Xlocator & \-Xsync\-methods 
これらのスイッチは現時点では無効化されています。この機能は将来、個別のダウンロードとして提供される予定です。 
.RE

.LP
.RE
.SS 
コンパイラの制限
.LP
.LP
通常は、関連するすべてのスキーマを、同じバインディングコンパイラスイッチを指定して 1 つの単位としてコンパイルするのがもっとも安全です。
.LP
.LP
xjc を実行するときは、次に示す制限に注意してください。これらの制限のほとんどは、xjc を何度か呼び出して複数のスキーマをコンパイルする場合にのみ適用されます。
.LP
.RS 3
.TP 2
o
複数のスキーマを同時にコンパイルする場合は、ターゲットの Java パッケージ名に次の優先順位の規則が適用されることに注意してください。 
.RS 3
.TP 3
1.
「\f2\-p\fP」コマンド行オプションがもっとも優先されます。 
.TP 3
2.
<\f2jaxb:package\fP> のカスタマイズ 
.TP 3
3.
\f2targetNamespace\fP が宣言されている場合は、仕様に定義されている \f2targetNamespace\fP \-> Java パッケージ名のアルゴリズムを適用します。 
.TP 3
4.
\f2targetNamespace\fP が宣言されていない場合は、"generated" という名前のハードコードされたパッケージを使用します。 
.RE
.TP 2
o
名前空間ごとに複数の <\f2jaxb:schemaBindings\fP> を持つことは不正です。 このため、1 つのターゲット名前空間内の 2 つのスキーマを、異なる Java パッケージにコンパイルすることはできません。 
.TP 2
o
1 つの Java パッケージにコンパイルされるすべてのスキーマは、XJC バインディングコンパイラに同時に送信する必要があります。 個別にコンパイルすることはできず、予期したとおりに動作しません。 
.TP 2
o
複数のスキーマファイルにまたがる要素置換グループは、同時にコンパイルする必要があります。 
.RE

.LP
.SH "関連項目"
.LP
.RS 3
.TP 2
o
コマンド行でのコンバータの実行 (XJC):[
.na
\f2コマンド行の命令\fP @
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/xjc.html、
.na
\f2xjc を Ant とともに使用する\fP @
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html] 
.TP 2
o
.na
\f2XML バインドのための JavaTM アーキテクチャー (JAXB)\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html 
.RE

.LP