javax.xml.parsers
クラス SAXParserFactory

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

public abstract class SAXParserFactory

extends Object

アプリケーションが SAX ベースのパーサを構成および取得して XML ドキュメントを構文解析できるようにするファクトリ API を定義します。

SAXParserFactory クラスの実装は、スレッドセーフであることは保証「されません」。複数のスレッドから SAXParserFactory が使用されるかどうかの確認はユーザアプリケーションで行います。別の方法として、アプリケーションはスレッド当たり SAXParserFactory の 1 つのインスタンスを持つことができます。ファクトリのインスタンスが複数のスレッドで同時に使用されなければ、アプリケーションはファクトリの同じインスタンスを使用して SAXParser の 1 つ以上のインスタンスを取得することができます。

static newInstance メソッドは、このクラスの新しい固定実装を返します。

導入されたバージョン:

JAXP 1.0

コンストラクタの概要

protected

SAXParserFactory()

メソッドの概要

abstract boolean	getFeature(String name) org.xml.sax.XMLReader の基本となる実装で要求された特定のプロパティを返します。
boolean	isNamespaceAware() ファクトリが名前空間を認識するパーサを作成するように設定されているかどうかを示します。
boolean	isValidating() 構文解析時に XML コンテンツを検証するパーサを作成するようにファクトリが設定されているかどうかを示します。
static SAXParserFactory	newInstance() SAXParserFactory の新しいインスタンスを取得します。
abstract SAXParser	newSAXParser() 現在設定されているファクトリパラメータを使用して SAXParser の新しいインスタンスを作成します。
abstract void	setFeature(String name, boolean value) org.xml.sax.XMLReader の基本となる実装に特定の機能を設定します。
void	setNamespaceAware(boolean awareness) このファクトリで作成されたパーサが XML 名前空間をサポートするように指定します。
void	setValidating(boolean validating) このファクトリで作成されたパーサが構文解析時にドキュメントを検証するように指定します。

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

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

コンストラクタの詳細

SAXParserFactory

protected SAXParserFactory()

メソッドの詳細

newInstance

public static SAXParserFactory newInstance()
                                    throws FactoryConfigurationError

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

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

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

戻り値:

SAXParserFactory の新しいインスタンス

例外:

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

newSAXParser

public abstract SAXParser newSAXParser()
                                throws ParserConfigurationException,
                                       SAXException

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

戻り値:

SAXParser の新しいインスタンス

例外:

ParserConfigurationException - 要求された構成を満たすパーサを生成できない場合

SAXException

setNamespaceAware

public void setNamespaceAware(boolean awareness)

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

パラメータ:

awareness - このファクトリで作成されたパーサが XML 名前空間をサポートする場合は true、そうでない場合は false

setValidating

public void setValidating(boolean validating)

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

パラメータ:

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

isNamespaceAware

public boolean isNamespaceAware()

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

戻り値:

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

isValidating

public boolean isValidating()

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

戻り値:

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

setFeature

public abstract void setFeature(String name,
                                boolean value)
                         throws ParserConfigurationException,
                                SAXNotRecognizedException,
                                SAXNotSupportedException

org.xml.sax.XMLReader の基本となる実装に特定の機能を設定します。コア機能とコアプロパティのリストについては、 http://www.megginson.com/SAX/Java/features.html のサイトを参照してください。

パラメータ:

name - 設定される機能の名前

value - 設定される機能の値

例外:

SAXNotRecognizedException - 基本となる XMLReader がプロパティ名を認識しない場合

SAXNotSupportedException - 基本となる XMLReader はプロパティ名を認識するが、そのプロパティをサポートしない場合

ParserConfigurationException

関連項目:

XMLReader.setFeature(java.lang.String, boolean)

getFeature

public abstract boolean getFeature(String name)
                            throws ParserConfigurationException,
                                   SAXNotRecognizedException,
                                   SAXNotSupportedException

org.xml.sax.XMLReader の基本となる実装で要求された特定のプロパティを返します。

パラメータ:

name - 取り出されるプロパティの名前

戻り値:

要求されたプロパティの値

例外:

SAXNotRecognizedException - 基本となる XMLReader がプロパティ名を認識しない場合

SAXNotSupportedException - 基本となる XMLReader はプロパティ名を認識するが、そのプロパティをサポートしない場合

ParserConfigurationException

関連項目:

XMLReader.getProperty(java.lang.String)