JavaTM 2
Platform
Std. Ed. v1.4.0

javax.xml.parsers
クラス SAXParser

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

public abstract class SAXParser
extends Object

XMLReader 実装クラスをラップする API を定義します。JAXP 1.0 では、このクラスは Parser インタフェースをラップしましたが、このインタフェースは XMLReader に置き換えられました。移行を簡単にするために、このクラスは同じ名前とインタフェースのサポートを継続し、新しいメソッドもサポートします。このクラスのインスタンスは SAXParserFactory.newSAXParser() メソッドから取得できます。このクラスのインスタンスを取得すると、さまざまな入力ソースから XML を構文解析できます。これらの入力ソースには、InputStream、ファイル、URL、および SAX InputSource があります。

基本となるパーサでコンテンツを構文解析する場合は、指定された HandlerBase または DefaultHandler のメソッドが呼び出されます。

基本となる実装をラップするこのクラスの実装側は、ParserAdapter クラスを使用してその SAX1 実装がこの改訂されたクラスの下で動作するように最初に適合させることを考慮できます。

SAXParser の実装は、2 つ以上のスレッドで同時に使用された場合、仕様どおりに動作することは保証「されません」。スレッド当たり SAXParser の 1 つのインスタンスにすることをお勧めします。複数のスレッドから SAXParser が使用されるかどうかの確認はアプリケーションで行います。

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

コンストラクタの概要
protected SAXParser()
           
 
メソッドの概要
abstract  Parser getParser()
          このクラスの実装によりカプセル化される SAX パーサを返します。
abstract  Object getProperty(String name)
          XMLReader の基本となる実装で要求された特定のプロパティを返します。
abstract  XMLReader getXMLReader()
          このクラスの実装によりカプセル化される XMLReader を返します。
abstract  boolean isNamespaceAware()
          このパーサが名前空間を認識するように設定されているかどうかを示します。
abstract  boolean isValidating()
          このパーサが XML ドキュメントを検証するように設定されているかどうかを示します。
 void parse(File f, DefaultHandler dh)
          指定されたファイルのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。
 void parse(File f, HandlerBase hb)
          指定されたファイルのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。
 void parse(InputSource is, DefaultHandler dh)
          指定された InputSource のコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。
 void parse(InputSource is, HandlerBase hb)
          指定された InputSource のコンテンツを、指定された HandlerBase を使用して XML として構文解析します。
 void parse(InputStream is, DefaultHandler dh)
          指定された InputStream インスタンスのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。
 void parse(InputStream is, DefaultHandler dh, String systemId)
          指定された InputStream インスタンスのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。
 void parse(InputStream is, HandlerBase hb)
          指定された InputStream インスタンスのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。
 void parse(InputStream is, HandlerBase hb, String systemId)
          指定された InputStream インスタンスのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。
 void parse(String uri, DefaultHandler dh)
          指定された URI (Uniform Resource Identifier) で説明されるコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。
 void parse(String uri, HandlerBase hb)
          指定された URI (Uniform Resource Identifier) で説明されるコンテンツを、指定された HandlerBase を使用して XML として構文解析します。
abstract  void setProperty(String name, Object value)
          XMLReader の基本となる実装に特定のプロパティを設定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

SAXParser

protected SAXParser()
メソッドの詳細

parse

public void parse(InputStream is,
                  HandlerBase hb)
           throws SAXException,
                  IOException
指定された InputStream インスタンスのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:
is - 構文解析されるコンテンツを含む InputStream
hb - 使用する SAX HandlerBase
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - 指定された InputStream が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

parse

public void parse(InputStream is,
                  HandlerBase hb,
                  String systemId)
           throws SAXException,
                  IOException
指定された InputStream インスタンスのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:
is - 構文解析されるコンテンツを含む InputStream
hb - 使用する SAX HandlerBase
systemId - 相対 URI を解決するのに必要なシステム ID
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - 指定された InputStream が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
version of this method instead.

parse

public void parse(InputStream is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
指定された InputStream インスタンスのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:
is - 構文解析されるコンテンツを含む InputStream
dh - 使用する SAX DefaultHandler
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - 指定された InputStream が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

parse

public void parse(InputStream is,
                  DefaultHandler dh,
                  String systemId)
           throws SAXException,
                  IOException
指定された InputStream インスタンスのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:
is - 構文解析されるコンテンツを含む InputStream
dh - 使用する SAX DefaultHandler
systemId - 相対 URI を解決するのに必要なシステム ID
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - 指定された InputStream が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
version of this method instead.

parse

public void parse(String uri,
                  HandlerBase hb)
           throws SAXException,
                  IOException
指定された URI (Uniform Resource Identifier) で説明されるコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:
uri - 構文解析されるコンテンツの場所
hb - 使用する SAX HandlerBase
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - uri が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

parse

public void parse(String uri,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
指定された URI (Uniform Resource Identifier) で説明されるコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:
uri - 構文解析されるコンテンツの場所
dh - 使用する SAX DefaultHandler
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - uri が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

parse

public void parse(File f,
                  HandlerBase hb)
           throws SAXException,
                  IOException
指定されたファイルのコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:
f - 構文解析対象の XML を含むファイル
hb - 使用する SAX HandlerBase
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - File オブジェクトが null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

parse

public void parse(File f,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
指定されたファイルのコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:
f - 構文解析対象の XML を含むファイル
dh - 使用する SAX DefaultHandler
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - File オブジェクトが null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

parse

public void parse(InputSource is,
                  HandlerBase hb)
           throws SAXException,
                  IOException
指定された InputSource のコンテンツを、指定された HandlerBase を使用して XML として構文解析します。HandlerBase クラスは SAX 2.0 では推奨されないので、このメソッドの DefaultHandler バージョンを使用することをお勧めします。

パラメータ:
is - 構文解析されるコンテンツを含む InputSource
hb - 使用する SAX HandlerBase
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - InputSource が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

parse

public void parse(InputSource is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
指定された InputSource のコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。

パラメータ:
is - 構文解析されるコンテンツを含む InputSource
dh - 使用する SAX DefaultHandler
例外:
IOException - 入出力エラーが発生した場合
IllegalArgumentException - InputSource が null の場合
SAXException - 構文解析時に基本となるパーサが SAXException をスローした場合
関連項目:
DocumentHandler

getParser

public abstract Parser getParser()
                          throws SAXException
このクラスの実装によりカプセル化される SAX パーサを返します。

戻り値:
このクラスの実装によりカプセル化される SAX パーサ
SAXException

getXMLReader

public abstract XMLReader getXMLReader()
                                throws SAXException
このクラスの実装によりカプセル化される XMLReader を返します。

戻り値:
このクラスの実装によりカプセル化される XMLReader
SAXException

isNamespaceAware

public abstract boolean isNamespaceAware()
このパーサが名前空間を認識するように設定されているかどうかを示します。

戻り値:
このパーサが名前空間を認識するように設定されている場合は true、そうでない場合は false

isValidating

public abstract boolean isValidating()
このパーサが XML ドキュメントを検証するように設定されているかどうかを示します。

戻り値:
このパーサが XML ドキュメントを検証するように設定されている場合は true、そうでない場合は false

setProperty

public abstract void setProperty(String name,
                                 Object value)
                          throws SAXNotRecognizedException,
                                 SAXNotSupportedException
XMLReader の基本となる実装に特定のプロパティを設定します。コア機能とコアプロパティのリストについては、 http://www.megginson.com/SAX/Java/features.html のサイトを参照してください。

パラメータ:
name - 設定されるプロパティの名前
value - 設定されるプロパティの値
例外:
SAXNotRecognizedException - 基本となる XMLReader がプロパティ名を認識しない場合
SAXNotSupportedException - 基本となる XMLReader はプロパティ名を認識するが、そのプロパティをサポートしない場合
関連項目:
XMLReader.setProperty(java.lang.String, java.lang.Object)

getProperty

public abstract Object getProperty(String name)
                            throws SAXNotRecognizedException,
                                   SAXNotSupportedException
XMLReader の基本となる実装で要求された特定のプロパティを返します。

パラメータ:
name - 取り出されるプロパティの名前
戻り値:
要求されたプロパティの値
例外:
SAXNotRecognizedException - 基本となる XMLReader がプロパティ名を認識しない場合
SAXNotSupportedException - 基本となる XMLReader はプロパティ名を認識するが、そのプロパティをサポートしない場合
関連項目:
XMLReader.getProperty(java.lang.String)

JavaTM 2
Platform
Std. Ed. v1.4.0

バグの報告と機能のリクエスト
これ以外の API リファレンスおよび開発者用ドキュメントについては、 Java 2 SDK SE 開発者用ドキュメントを参照してください。 開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、 およびコード実例が含まれています。

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.