javax.xml.stream

クラス XMLOutputFactory

java.lang.Object

javax.xml.stream.XMLOutputFactory

public abstract class XMLOutputFactory
extends Object

XMLEventWriter および XMLStreamWriter を取得するためのファクトリの抽象実装を定義します。 次の表に、この仕様の標準プロパティーの定義を示します。各プロパティーは、実装ごとに必要となるサポートのレベルが異なります。必要なサポートレベルは、「必須」の列に示されています。

構成パラメータ
プロパティー名	動作	戻り型	デフォルト値	必須
javax.xml.stream.isRepairingNamespaces	出力側の接頭辞のデフォルトを設定します	Boolean	False	はい

次に、名前空間と接頭辞の修復アルゴリズムについて説明します。

プロパティーは次のコード行で設定できます。setProperty("javax.xml.stream.isRepairingNamespaces",new Boolean(true|false));

このプロパティーは、ライターのデフォルトの名前空間接頭辞の宣言を指定します。デフォルト値は false です。

ライターが名前空間を補修する場合、ライターは範囲内に名前空間宣言を現在持たないすべての属性に対して、現在の StartElement に名前空間宣言を作成します。StartElement に URI が指定されているが、接頭辞が指定されていない場合、接頭辞が割り当てられます。現在の StartElement の親で接頭辞が宣言されていない場合、接頭辞は現在の StartElement で宣言されます。defaultNamespace がバインドされていて範囲内にあり、デフォルトの名前空間が属性の URI または StartElement QName に一致する場合、接頭辞は割り当てられません。

要素名または属性名に接頭辞が含まれるが、どの名前空間 URI にもバインドされていない場合、直列化中に接頭辞が削除されます。

同じ開始タグまたは空の要素タグ内の要素名や属性名が異なる名前空間 URI にバインドされていて、同じ接頭辞を使用している場合、要素または最初に現れる属性は元の接頭辞を保持し、後続の属性は接頭辞を属性の名前空間 URI にバインドされた新しい接頭辞で置き換えます。

要素名または属性名が、要素の親の名前空間コンテキストから継承したものとは異なる URI にバインドされている接頭辞を使用し、現在の要素のコンテキストに名前空間宣言が存在しない場合、そのような名前空間宣言が追加されます。

要素名または属性名が接頭辞にバインドされていて、接頭辞を別の URI にバインドする名前空間宣言が存在する場合、その名前空間宣言は、正しいマッピングがその要素の親コンテキストから継承されている場合は削除され、それ以外の場合はその接頭辞を使用する要素または属性の名前空間 URI に変更されます。

導入されたバージョン:

1.6

関連項目:

XMLInputFactory, XMLEventWriter, XMLStreamWriter

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	IS_REPAIRING_NAMESPACES 接頭辞を出力側でデフォルト設定するために使用されるプロパティー。

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	XMLOutputFactory()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract XMLEventWriter	createXMLEventWriter(OutputStream stream) ストリームへの書き込みを行う新しい XMLEventWriter を作成します。
abstract XMLEventWriter	createXMLEventWriter(OutputStream stream, String encoding) ストリームへの書き込みを行う新しい XMLEventWriter を作成します。
abstract XMLEventWriter	createXMLEventWriter(Result result) JAXP 結果への書き込みを行う新しい XMLEventWriter を作成します。
abstract XMLEventWriter	createXMLEventWriter(Writer stream) ライターへの書き込みを行う新しい XMLEventWriter を作成します。
abstract XMLStreamWriter	createXMLStreamWriter(OutputStream stream) ストリームへの書き込みを行う新しい XMLStreamWriter を作成します。
abstract XMLStreamWriter	createXMLStreamWriter(OutputStream stream, String encoding) ストリームへの書き込みを行う新しい XMLStreamWriter を作成します。
abstract XMLStreamWriter	createXMLStreamWriter(Result result) JAXP 結果への書き込みを行う新しい XMLStreamWriter を作成します。
abstract XMLStreamWriter	createXMLStreamWriter(Writer stream) ライターへの書き込みを行う新しい XMLStreamWriter を作成します。
abstract Object	getProperty(String name) ベースとなる実装から機能またはプロパティーを取得します。
abstract boolean	isPropertySupported(String name) このファクトリがサポートするプロパティーセットを照会します。
static XMLOutputFactory	newFactory() ファクトリの新しいインスタンスを作成します。
static XMLOutputFactory	newFactory(String factoryId, ClassLoader classLoader) ファクトリの新しいインスタンスを作成します。
static XMLOutputFactory	newInstance() ファクトリの新しいインスタンスを作成します。
static XMLInputFactory	newInstance(String factoryId, ClassLoader classLoader) 非推奨。 このメソッドは、間違ったクラスである XMLInputFactory のインスタンスを返すため、非推奨になっています。代わりに、新しいメソッド newFactory(java.lang.String, java.lang.ClassLoader) を使用してください。
abstract void	setProperty(String name, Object value) ユーザーがベースとなる実装に特定の機能とプロパティーを設定できるようにします。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

IS_REPAIRING_NAMESPACES

public static final String IS_REPAIRING_NAMESPACES

接頭辞を出力側でデフォルト設定するために使用されるプロパティー。

関連項目:

定数フィールド値

コンストラクタの詳細

XMLOutputFactory

protected XMLOutputFactory()

メソッドの詳細

newInstance

public static XMLOutputFactory newInstance()
                                    throws FactoryConfigurationError

ファクトリの新しいインスタンスを作成します。

例外:

FactoryConfigurationError - このファクトリのインスタンスをロードできない場合

newFactory

public static XMLOutputFactory newFactory()
                                   throws FactoryConfigurationError

ファクトリの新しいインスタンスを作成します。この static メソッドは新しいファクトリインスタンスを作成します。このメソッドは次の順序の検索手順で、ロードする XMLOutputFactory 実装クラスを決定します。javax.xml.stream.XMLOutputFactory システムプロパティーを使用する。JRE ディレクトリ内のプロパティーファイル lib/stax.properties を使用する。この構成ファイルは標準の java.util.Properties 形式であり、上記のように定義されたシステムプロパティーであるキーを持つ実装クラスの完全指定の名前を含む。可能であれば、JAR 仕様で詳細に説明されているサービス API を使用して、クラス名を判定する。サービス API は、実行時に使用できる jar 内の META-INF/services/javax.xml.stream.XMLOutputFactory ファイルからクラス名を検索する。デフォルトの XMLOutputFactory インスタンスをプラットフォームとする。 アプリケーションが XMLOutputFactory への参照を取得すると、ファクトリを使用してストリームのインスタンスを構成および取得することができます。 これは非推奨の newInstance() メソッドを置き換える新しいメソッドです。非推奨のメソッドに関連して、この置換メソッドによって定義されている動作に変更はありません。

例外:

FactoryConfigurationError - このファクトリのインスタンスをロードできない場合

newInstance

public static XMLInputFactory newInstance(String factoryId,
                          ClassLoader classLoader)
                                   throws FactoryConfigurationError

非推奨。 このメソッドは、間違ったクラスである XMLInputFactory のインスタンスを返すため、非推奨になっています。代わりに、新しいメソッド newFactory(java.lang.String, java.lang.ClassLoader) を使用してください。

ファクトリの新しいインスタンスを作成します。

パラメータ:

factoryId - 検索するファクトリの名前。プロパティー名と同一

classLoader - 使用する classLoader

戻り値:

ファクトリの実装

例外:

FactoryConfigurationError - このファクトリのインスタンスをロードできない場合

newFactory

public static XMLOutputFactory newFactory(String factoryId,
                          ClassLoader classLoader)
                                   throws FactoryConfigurationError

ファクトリの新しいインスタンスを作成します。classLoader 引数が null の場合、ContextClassLoader が使用されます。 これは非推奨の newInstance(String factoryId、ClassLoader classLoader) メソッドを置き換える新しいメソッドです。 非推奨のメソッドに関連して、この置換メソッドによって定義されている動作に変更はありません。

パラメータ:

factoryId - 検索するファクトリの名前。プロパティー名と同一

classLoader - 使用する classLoader

戻り値:

ファクトリの実装

例外:

FactoryConfigurationError - このファクトリのインスタンスをロードできない場合

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(Writer stream)
                                               throws XMLStreamException

ライターへの書き込みを行う新しい XMLStreamWriter を作成します。

パラメータ:

stream - 書き込み先のライター

例外:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(OutputStream stream)
                                               throws XMLStreamException

ストリームへの書き込みを行う新しい XMLStreamWriter を作成します。

パラメータ:

stream - 書き込み先のストリーム

例外:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(OutputStream stream,
                                    String encoding)
                                               throws XMLStreamException

ストリームへの書き込みを行う新しい XMLStreamWriter を作成します。

パラメータ:

stream - 書き込み先のストリーム

encoding - 使用するエンコーディング

例外:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(Result result)
                                               throws XMLStreamException

JAXP 結果への書き込みを行う新しい XMLStreamWriter を作成します。このメソッドはオプションです。

パラメータ:

result - 書き込み先の結果

例外:

UnsupportedOperationException - この XMLOutputFactory でこのメソッドがサポートされていない場合

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(Result result)
                                             throws XMLStreamException

JAXP 結果への書き込みを行う新しい XMLEventWriter を作成します。このメソッドはオプションです。

パラメータ:

result - 書き込み先の結果

例外:

UnsupportedOperationException - この XMLOutputFactory でこのメソッドがサポートされていない場合

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(OutputStream stream)
                                             throws XMLStreamException

ストリームへの書き込みを行う新しい XMLEventWriter を作成します。

パラメータ:

stream - 書き込み先のストリーム

例外:

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(OutputStream stream,
                                  String encoding)
                                             throws XMLStreamException

ストリームへの書き込みを行う新しい XMLEventWriter を作成します。

パラメータ:

stream - 書き込み先のストリーム

encoding - 使用するエンコーディング

例外:

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(Writer stream)
                                             throws XMLStreamException

ライターへの書き込みを行う新しい XMLEventWriter を作成します。

パラメータ:

stream - 書き込み先のストリーム

例外:

XMLStreamException

setProperty

public abstract void setProperty(String name,
               Object value)
                          throws IllegalArgumentException

ユーザーがベースとなる実装に特定の機能とプロパティーを設定できるようにします。

パラメータ:

name - プロパティーの名前

value - プロパティーの値

例外:

IllegalArgumentException - プロパティーがサポートされていない場合

getProperty

public abstract Object getProperty(String name)
                            throws IllegalArgumentException

ベースとなる実装から機能またはプロパティーを取得します。

パラメータ:

name - プロパティーの名前

戻り値:

プロパティーの値

例外:

IllegalArgumentException - プロパティーがサポートされていない場合

isPropertySupported

public abstract boolean isPropertySupported(String name)

このファクトリがサポートするプロパティーセットを照会します。

パラメータ:

name - プロパティーの名前 (null 以外)

戻り値:

プロパティーがサポートされている場合は true、そうでない場合は false