DocumentBuilderFactory (Java 2 プラットフォーム SE v1.4.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2
Platform
Std. Ed. v1.4.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.xml.parsers
クラス DocumentBuilderFactory

java.lang.Object
  |
  +--javax.xml.parsers.DocumentBuilderFactory

public abstract class DocumentBuilderFactory
extends Object

XML ドキュメントから DOM オブジェクトツリーを作成するパーサをアプリケーションが取得できるようにするファクトリ API を定義します。DocumentBuilderFactory クラスの実装は、スレッドセーフであることは保証「されません」。複数のスレッドから DocumentBuilderFactory が使用されるかどうかの確認はユーザアプリケーションで行います。別の方法として、アプリケーションはスレッド当たり DocumentBuilderFactory の 1 つのインスタンスを持つことができます。ファクトリのインスタンスが複数のスレッドで同時に使用されなければ、アプリケーションはファクトリの同じインスタンスを使用して DocumentBuilder の 1 つ以上のインスタンスを取得することができます。

導入されたバージョン:: JAXP 1.0

コンストラクタの概要

protected DocumentBuilderFactory()


メソッドの概要

abstract Object getAttribute(String name)
          ユーザが基本となる実装の特定の属性を取り出すことができるようにします。

boolean isCoalescing()
          CDATA ノードを Text ノードに変換し、それを隣接 (存在する場合) Text ノードに追加するパーサを作成するようにファクトリが設定されているかどうかを示します。

boolean isExpandEntityReferences()
          エンティティ参照ノードを展開するパーサを作成するようにファクトリが設定されているかどうかを示します。

boolean isIgnoringComments()
          コメントを無視するパーサを作成するようにファクトリが設定されているかどうかを示します。

boolean isIgnoringElementContentWhitespace()
          要素コンテンツ内の無視できる空白を無視するパーサを作成するようにファクトリが設定されているかどうかを示します。

boolean isNamespaceAware()
          ファクトリが名前空間を認識するパーサを作成するように設定されているかどうかを示します。

boolean isValidating()
          構文解析時に XML コンテンツを検証するパーサを作成するようにファクトリが設定されているかどうかを示します。

abstract DocumentBuilder newDocumentBuilder()
          現在設定されているパラメータを使用して DocumentBuilder の新しいインスタンスを作成します。

static DocumentBuilderFactory newInstance()
          DocumentBuilderFactory の新しいインスタンスを取得します。

abstract void setAttribute(String name, Object value)
          ユーザが基本となる実装に特定の属性を設定できるようにします。

void setCoalescing(boolean coalescing)
          このファクトリで作成されたパーサが CDATA ノードを Text ノードに変換し、それを隣接 (存在する場合) Text ノードに追加するように指定します。

void setExpandEntityReferences(boolean expandEntityRef)
          このファクトリで作成されたパーサがエンティティ参照ノードを展開するように指定します。

void setIgnoringComments(boolean ignoreComments)
          このファクトリで作成されたパーサがコメントを無視するように指定します。

void setIgnoringElementContentWhitespace(boolean whitespace)
          このファクトリで作成されたパーサが、XML ドキュメントの構文解析時に要素コンテンツの空白 (大まかに「無視できる空白」と呼ばれることがある) を排除するように指定します (XML Rec 2.10 を参照)。

void setNamespaceAware(boolean awareness)
          このファクトリで作成されたパーサが XML 名前空間をサポートするように指定します。

void setValidating(boolean validating)
          このファクトリで作成されたパーサが構文解析時にドキュメントの妥当性を検証するように指定します。

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

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

コンストラクタの詳細

DocumentBuilderFactory

protected DocumentBuilderFactory()

メソッドの詳細

newInstance

public static DocumentBuilderFactory newInstance()
                                          throws FactoryConfigurationError

DocumentBuilderFactory の新しいインスタンスを取得します。この static メソッドは新しいファクトリインスタンスを作成します。このメソッドは次の順序のルックアップ手順で、ロードする DocumentBuilderFactory 実装クラスを判定します。

javax.xml.parsers.DocumentBuilderFactory システムプロパティを使用する
JRE ディレクトリ内のプロパティファイル lib/jaxp.properties を使用する。この構成ファイルは標準の java.util.Properties 形式であり、上記のように定義されたシステムプロパティであるキーを持つ実装クラスの完全指定の名前を含む
可能であれば、JAR 仕様で詳細に説明されているサービス API を使用して、クラス名を判定する。サービス API は、実行時に使用できる jar 内の META-INF/services/javax.xml.parsers.DocumentBuilderFactory ファイルからクラス名を検索する
プラットフォームのデフォルトの DocumentBuilderFactory インスタンス

アプリケーションが DocumentBuilderFactory への参照を取得すると、ファクトリを使用してパーサのインスタンスを設定および取得することができます。

例外:: FactoryConfigurationError - 実装が使用できないかインスタンス化できない場合

newDocumentBuilder

public abstract DocumentBuilder newDocumentBuilder()
                                            throws ParserConfigurationException

現在設定されているパラメータを使用して DocumentBuilder の新しいインスタンスを作成します。

戻り値:: DocumentBuilder の新しいインスタンス
例外:: ParserConfigurationException - 要求された構成を満たす DocumentBuilder を生成できない場合

setNamespaceAware

public void setNamespaceAware(boolean awareness)

このファクトリで作成されたパーサが XML 名前空間をサポートするように指定します。デフォルトでは、この値は false に設定されます。

パラメータ:: awareness - 作成されたパーサが XML 名前空間をサポートする場合は true、そうでない場合は false

setValidating

public void setValidating(boolean validating)

このファクトリで作成されたパーサが構文解析時にドキュメントの妥当性を検証するように指定します。デフォルトでは、この値は false に設定されます。

パラメータ:: validating - 作成されたパーサが構文解析時にドキュメントの妥当性を検証する場合は true、そうでない場合は false

setIgnoringElementContentWhitespace

public void setIgnoringElementContentWhitespace(boolean whitespace)

このファクトリで作成されたパーサが、XML ドキュメントの構文解析時に要素コンテンツの空白 (大まかに「無視できる空白」と呼ばれることがある) を排除するように指定します (XML Rec 2.10 を参照)。要素だけのコンテンツモデル (XML Rec 3.2.1 を参照) を持つ要素コンテンツ内に直接含まれる空白だけが排除されます。コンテンツモデルに依存しているために、この設定ではパーサが検証モードであることが必要です。デフォルトでは、この値は false に設定されます。

パラメータ:: whitespace - 作成されたパーサが XML ドキュメントの構文解析時に要素コンテンツ内の空白を排除する必要がある場合は true、そうでない場合は false

setExpandEntityReferences

public void setExpandEntityReferences(boolean expandEntityRef)

このファクトリで作成されたパーサがエンティティ参照ノードを展開するように指定します。デフォルトでは、この値は true に設定されます。

パラメータ:: expandEntityRef - 作成されたパーサがエンティティ参照ノードを展開する場合は true、そうでない場合は false

setIgnoringComments

public void setIgnoringComments(boolean ignoreComments)

このファクトリで作成されたパーサがコメントを無視するように指定します。デフォルトでは、この値は false に設定されます。

setCoalescing

public void setCoalescing(boolean coalescing)

このファクトリで作成されたパーサが CDATA ノードを Text ノードに変換し、それを隣接 (存在する場合) Text ノードに追加するように指定します。デフォルトでは、この値は false に設定されます。

パラメータ:: coalescing - 作成されたパーサが CDATA ノードを Text ノードに変換し、それを隣接 (存在する場合) Text ノードに追加する場合は true、そうでない場合は false

isNamespaceAware

public boolean isNamespaceAware()

ファクトリが名前空間を認識するパーサを作成するように設定されているかどうかを示します。

戻り値:: ファクトリが名前空間を認識するパーサを作成するように設定されている場合は true、そうでない場合は false

isValidating

public boolean isValidating()

構文解析時に XML コンテンツを検証するパーサを作成するようにファクトリが設定されているかどうかを示します。

戻り値:: 構文解析時に XML コンテンツを検証するパーサを作成するようにファクトリが設定されている場合は true、そうでない場合は false

isIgnoringElementContentWhitespace

public boolean isIgnoringElementContentWhitespace()

要素コンテンツ内の無視できる空白を無視するパーサを作成するようにファクトリが設定されているかどうかを示します。

戻り値:: 要素コンテンツ内の無視できる空白を無視するパーサを作成するようにファクトリが設定されている場合は true、そうでない場合は false

isExpandEntityReferences

public boolean isExpandEntityReferences()

エンティティ参照ノードを展開するパーサを作成するようにファクトリが設定されているかどうかを示します。

戻り値:: エンティティ参照ノードを展開するパーサを作成するようにファクトリが設定されている場合は true、そうでない場合は false

isIgnoringComments

public boolean isIgnoringComments()

コメントを無視するパーサを作成するようにファクトリが設定されているかどうかを示します。

戻り値:: コメントを無視するパーサを作成するようにファクトリが設定されている場合は true、そうでない場合は false

isCoalescing

public boolean isCoalescing()

CDATA ノードを Text ノードに変換し、それを隣接 (存在する場合) Text ノードに追加するパーサを作成するようにファクトリが設定されているかどうかを示します。

戻り値:: CDATA ノードを Text ノードに変換し、それを隣接 (存在する場合) Text ノードに追加するパーサを作成するようにファクトリが設定されている場合は true、そうでない場合は false

setAttribute

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

ユーザが基本となる実装に特定の属性を設定できるようにします。

パラメータ:: name - 属性の名前; value - 属性の値
例外:: IllegalArgumentException - 基本となる実装が属性を認識しない場合にスローされる

getAttribute

public abstract Object getAttribute(String name)
                             throws IllegalArgumentException

ユーザが基本となる実装の特定の属性を取り出すことができるようにします。

パラメータ:: name - 属性の名前
戻り値:: 属性の値
例外:: IllegalArgumentException - 基本となる実装が属性を認識しない場合にスローされる

概要