SAXParser (Java Platform SE 7)

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

```
public abstract class SAXParser
extends Object
```
XMLReader 実装クラスをラップする API を定義します。JAXP 1.0 では、このクラスは Parser インタフェースをラップしましたが、このインタフェースは XMLReader に置き換えられています。移行を簡単にするために、このクラスは新しいメソッドのサポートと同様、同じ名前とインタフェースのサポートも継続します。このクラスのインスタンスは SAXParserFactory.newSAXParser() メソッドにより取得できます。このクラスのインスタンスを取得すると、さまざまな入力ソースから XML ドキュメントを構文解析できます。これらの入力ソースには、InputStream、File、URL、および SAX InputSource があります。
この static メソッドは、システムプロパティー設定に基づいて新しいファクトリインスタンスを作成するか、またはプロパティーが定義されていない場合にプラットフォームのデフォルトを使用します。
どのファクトリ実装を作成するかを制御するシステムプロパティーの名前は "javax.xml.parsers.SAXParserFactory" です。このプロパティーは、この abstract クラスの具象サブクラスを命名します。プロパティーが定義されていない場合は、プラットフォームのデフォルトが使用されます。
コンテンツはベースとなるパーサーで構文解析されるため、指定された HandlerBase または DefaultHandler のメソッドが呼び出されます。
ベースとなる実装をラップするこのクラスの実装側では、ParserAdapter クラスを使用して、その SAX1 実装をこの改訂されたクラスの下で動作するように、最初に適合させることを考慮できます。

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

コンストラクタ
修飾子コンストラクタと説明

protected SAXParser()
インストールを妨げる protected コンストラクタです。

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`SAXParser()` インストールを妨げる protected コンストラクタです。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`abstract Parser`	`getParser()` このクラスの実装によりカプセル化される SAX パーサーを返します。
`abstract Object`	`getProperty(String name)` `XMLReader` のベースとなる実装で要求された特定のプロパティーを返します。
`Schema`	`getSchema()` XML プロセッサによって使用される `Schema` への参照を取得します。
`abstract XMLReader`	`getXMLReader()` このクラスの実装によりカプセル化される `XMLReader` を返します。
`abstract boolean`	`isNamespaceAware()` このパーサーが名前空間を認識するように構成されているかどうかを示します。
`abstract boolean`	`isValidating()` このパーサーが XML ドキュメントを検証するように構成されているかどうかを示します。
`boolean`	`isXIncludeAware()` このパーサーの XInclude 処理モードを取得します。
`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)` 指定された `DefaultHandler` を使用して、指定された `InputStream` インスタンスの内容を XML として構文解析します。
`void`	`parse(InputStream is, DefaultHandler dh, String systemId)` 指定された `DefaultHandler` を使用して、指定された `InputStream` インスタンスの内容を XML として構文解析します。
`void`	`parse(InputStream is, HandlerBase hb)` 指定された `HandlerBase` を使用して、指定された `InputStream` インスタンスの内容を XML として構文解析します。
`void`	`parse(InputStream is, HandlerBase hb, String systemId)` 指定された `HandlerBase` を使用して、指定された `InputStream` インスタンスの内容を 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 として構文解析します。
`void`	`reset()` この `SAXParser` を元の構成にリセットします。
`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()
```
    インストールを妨げる protected コンストラクタです。SAXParserFactory.newSAXParser() を使用してください。
- メソッドの詳細
  - reset
```
public void reset()
```
    この SAXParser を元の構成にリセットします。
    
    SAXParser は、SAXParserFactory.newSAXParser() で作成された時点の状態にリセットされます。reset() は、既存の SAXParser の再使用を許可するように設計されているため、新しい SAXParser の作成に関連するリソースを節約できます。
    
    SAXParser をリセットした場合、同じ Schema Object (たとえば、Object.equals(Object obj)) を持つことは保証されません。機能的に同じ Schema を持つことは保証されます。
    
    例外:
    
    UnsupportedOperationException - 実装がこのメソッドをオーバーライドしない場合。
    導入されたバージョン:
    
    1.5
  - parse
```
public void parse(InputStream is,
         HandlerBase hb)
           throws SAXException,
                  IOException
```
    指定された HandlerBase を使用して、指定された InputStream インスタンスの内容を XML として構文解析します。HandlerBase クラスは SAX 2.0 では非推奨であるため、このメソッドの DefaultHandler バージョンを使用することをお勧めします。
    
    パラメータ:
    is - 構文解析されるコンテンツを含む InputStream。
    hb - 使用する SAX HandlerBase。
    
    例外:
    
    IllegalArgumentException - 指定された InputStream が null の場合。
    
    SAXException - 構文解析で SAX エラーが生成された場合。
    
    IOException - InputStream とのやりとりで入出力エラーが発生した場合。
    関連項目:
    DocumentHandler
  - parse
```
public void parse(InputStream is,
         HandlerBase hb,
         String systemId)
           throws SAXException,
                  IOException
```
    指定された HandlerBase を使用して、指定された InputStream インスタンスの内容を XML として構文解析します。HandlerBase クラスは SAX 2.0 では非推奨であるため、このメソッドの DefaultHandler バージョンを使用することをお勧めします。
    
    パラメータ:
    is - 構文解析されるコンテンツを含む InputStream。
    hb - 使用する SAX HandlerBase。
    systemId - 相対 URI を解決するのに必要なシステム識別子。
    
    例外:
    
    IllegalArgumentException - 指定された InputStream が null である場合。
    
    IOException - InputStream とのやりとりで入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    version of this method instead.
  - parse
```
public void parse(InputStream is,
         DefaultHandler dh)
           throws SAXException,
                  IOException
```
    指定された DefaultHandler を使用して、指定された InputStream インスタンスの内容を XML として構文解析します。
    
    パラメータ:
    is - 構文解析されるコンテンツを含む InputStream。
    dh - 使用する SAX DefaultHandler。
    
    例外:
    
    IllegalArgumentException - 指定された InputStream が null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    DocumentHandler
  - parse
```
public void parse(InputStream is,
         DefaultHandler dh,
         String systemId)
           throws SAXException,
                  IOException
```
    指定された DefaultHandler を使用して、指定された InputStream インスタンスの内容を XML として構文解析します。
    
    パラメータ:
    is - 構文解析されるコンテンツを含む InputStream。
    dh - 使用する SAX DefaultHandler。
    systemId - 相対 URI を解決するのに必要なシステム識別子。
    
    例外:
    
    IllegalArgumentException - 指定された InputStream が null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    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。
    
    例外:
    
    IllegalArgumentException - uri が null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    DocumentHandler
  - parse
```
public void parse(String uri,
         DefaultHandler dh)
           throws SAXException,
                  IOException
```
    指定された URI (Uniform Resource Identifier) で表わされたコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。
    
    パラメータ:
    uri - 構文解析されるコンテンツの場所。
    dh - 使用する SAX DefaultHandler。
    
    例外:
    
    IllegalArgumentException - uri が null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    DocumentHandler
  - parse
```
public void parse(File f,
         HandlerBase hb)
           throws SAXException,
                  IOException
```
    指定されたファイルの内容を、指定された HandlerBase を使用して XML として構文解析します。 HandlerBase クラスは SAX 2.0 では非推奨のため、このメソッドの DefaultHandler バージョンを使用することをお勧めします。
    
    パラメータ:
    f - 構文解析対象の XML を含むファイル
    hb - 使用する SAX HandlerBase。
    
    例外:
    
    IllegalArgumentException - File オブジェクトが null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    DocumentHandler
  - parse
```
public void parse(File f,
         DefaultHandler dh)
           throws SAXException,
                  IOException
```
    指定されたファイルの内容を、指定された DefaultHandler を使用して XML として構文解析します。
    
    パラメータ:
    f - 構文解析対象の XML を含むファイル
    dh - 使用する SAX DefaultHandler。
    
    例外:
    
    IllegalArgumentException - File オブジェクトが null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    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。
    
    例外:
    
    IllegalArgumentException - InputSource オブジェクトが null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    DocumentHandler
  - parse
```
public void parse(InputSource is,
         DefaultHandler dh)
           throws SAXException,
                  IOException
```
    指定された InputSource のコンテンツを、指定された DefaultHandler を使用して XML として構文解析します。
    
    パラメータ:
    is - 構文解析されるコンテンツを含む InputSource。
    dh - 使用する SAX DefaultHandler。
    
    例外:
    
    IllegalArgumentException - InputSource オブジェクトが null の場合。
    
    IOException - 入出力エラーが発生した場合。
    
    SAXException - 処理中に SAX エラーが発生した場合。
    関連項目:
    DocumentHandler
  - getParser
```
public abstract Parser getParser()
                          throws SAXException
```
    このクラスの実装によりカプセル化される SAX パーサーを返します。
    
    戻り値:
    このクラスの実装によりカプセル化される SAX パーサー。
    
    例外:
    
    SAXException - 処理中に SAX エラーが発生した場合。
  - getXMLReader
```
public abstract XMLReader getXMLReader()
                                throws SAXException
```
    このクラスの実装によりカプセル化される XMLReader を返します。
    
    戻り値:
    このクラスの実装によりカプセル化される XMLReader。
    
    例外:
    
    SAXException - 処理中に SAX エラーが発生した場合。
  - 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://sax.sourceforge.net/?selected=get-set のサイトを参照してください。
    
    JAXP 1.5 またはそれ以降を実装する実装はすべて、XMLConstants.ACCESS_EXTERNAL_DTD および XMLConstants.ACCESS_EXTERNAL_SCHEMA プロパティーをサポートしている必要があります。
    - XMLConstants.ACCESS_EXTERNAL_DTD プロパティーを設定すると、外部 DTD および外部エンティティー参照へのアクセスが、そのプロパティーで指定されたプロトコルに制限されます。このプロパティーの制限が原因で構文解析中にアクセスが拒否された場合は、SAXParser で定義された解析メソッドによって SAXException がスローされます。
      
      XMLConstants.ACCESS_EXTERNAL_SCHEMA プロパティーを設定すると、schemaLocation 属性によって設定された外部スキーマへのアクセスが、そのプロパティーで指定されたプロトコルに制限されます。このプロパティーの制限が原因で構文解析中にアクセスが拒否された場合は、SAXParser で定義された解析メソッドによって SAXException がスローされます。
    パラメータ:
    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)
  - getSchema
```
public Schema getSchema()
```
    XML プロセッサによって使用される Schema への参照を取得します。
    
    スキーマを使用していない場合は null が返されます。
    
    戻り値:
    使用されている Schema または使用されていない場合は null
    
    例外:
    
    UnsupportedOperationException - 実装がこのメソッドをオーバーライドしない場合
    導入されたバージョン:
    
    1.5
  - isXIncludeAware
```
public boolean isXIncludeAware()
```
    このパーサーの XInclude 処理モードを取得します。
    
    戻り値:
    このパーサーがファクトリから作成されたときに SAXParserFactory.isXIncludeAware() から返される値。
    
    例外:
    
    UnsupportedOperationException - 実装がこのメソッドをオーバーライドしない場合
    導入されたバージョン:
    
    1.5
    
    関連項目:
    SAXParserFactory.setXIncludeAware(boolean)

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス SAXParser

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

メソッドのサマリー

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

コンストラクタの詳細

SAXParser

メソッドの詳細

reset

parse

parse

parse

parse

parse

parse

parse

parse

parse

parse

getParser

getXMLReader

isNamespaceAware

isValidating

setProperty

getProperty

getSchema

isXIncludeAware