public class DefaultHandler extends Object implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler
このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。詳細については、http://www.saxproject.org を参照してください。
このクラスは、SAX2 アプリケーション用の簡易基底クラスです。SAX2 の 4 つのコアハンドラクラスに含まれるすべてのコールバックのデフォルト実装を提供します。
アプリケーションの作成者は、インタフェースの一部だけを実装する必要があるとき、このクラスを拡張します。パーサーの作成者は、アプリケーション固有のデフォルトハンドラが提供されないとき、このクラスをインスタンス化してデフォルトハンドラを提供します。
このクラスは、非推奨に指定されている SAX1 の HandlerBase
クラスに代わるクラスです。
EntityResolver
, DTDHandler
, ContentHandler
, ErrorHandler
コンストラクタと説明 |
---|
DefaultHandler() |
修飾子と型 | メソッドと説明 |
---|---|
void |
characters(char[] ch, int start, int length)
要素内の文字データの通知を受け取ります。
|
void |
endDocument()
文書の終了通知を受け取ります。
|
void |
endElement(String uri, String localName, String qName)
要素の終了通知を受け取ります。
|
void |
endPrefixMapping(String prefix)
名前空間マッピングの終了通知を受け取ります。
|
void |
error(SAXParseException e)
回復可能なパーサーエラーの通知を受け取ります。
|
void |
fatalError(SAXParseException e)
致命的な XML 構文解析エラーを報告します。
|
void |
ignorableWhitespace(char[] ch, int start, int length)
要素コンテンツに含まれる無視できる空白文字の通知を受け取ります。
|
void |
notationDecl(String name, String publicId, String systemId)
表記法宣言の通知を受け取ります。
|
void |
processingInstruction(String target, String data)
処理命令の通知を受け取ります。
|
InputSource |
resolveEntity(String publicId, String systemId)
外部エンティティーを解決します。
|
void |
setDocumentLocator(Locator locator)
文書イベントの Locator オブジェクトを受け取ります。
|
void |
skippedEntity(String name)
スキップされたエンティティーの通知を受け取ります。
|
void |
startDocument()
文書の開始通知を受け取ります。
|
void |
startElement(String uri, String localName, String qName, Attributes attributes)
要素の開始通知を受け取ります。
|
void |
startPrefixMapping(String prefix, String uri)
名前空間マッピングの開始通知を受け取ります。
|
void |
unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
解析対象外エンティティー宣言の通知を受け取ります。
|
void |
warning(SAXParseException e)
パーサー警告の通知を受け取ります。
|
public InputSource resolveEntity(String publicId, String systemId) throws IOException, SAXException
常に null を返します。これは、パーサーに XML 文書内のシステム識別子を使用させるためです。このメソッドは SAX のデフォルトの動作を実装します。アプリケーションの作成者は、サブクラス内でこれをオーバーライドし、カタログ検索や URI リダイレクションのような特殊な変換を行います。
resolveEntity
、インタフェース: EntityResolver
publicId
- 公開識別子。使用できない場合は null。systemId
- XML 文書に含まれているシステム識別子。IOException
- 新しい入力ソースの設定中にエラーが発生した場合。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。EntityResolver.resolveEntity(java.lang.String, java.lang.String)
public void notationDecl(String name, String publicId, String systemId) throws SAXException
デフォルトでは何も行いません。文書内に宣言された表記法を追跡する必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。
notationDecl
、インタフェース: DTDHandler
name
- 表記法名。publicId
- 表記法の公開識別子。使用できない場合は null。systemId
- 表記法のシステム識別子。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException
デフォルトでは何も行いません。文書内に宣言された解析対象外エンティティーを追跡する必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。
unparsedEntityDecl
、インタフェース: DTDHandler
name
- エンティティー名。publicId
- エンティティーの公開識別子。使用できない場合は null。systemId
- エンティティーのシステム識別子。notationName
- 関連表記法名。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void setDocumentLocator(Locator locator)
デフォルトでは何も行いません。その他の文書イベントで使用するためにロケータを格納しておく必要がある場合、アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドします。
setDocumentLocator
、インタフェース: ContentHandler
locator
- すべての SAX 文書イベントのロケータ。ContentHandler.setDocumentLocator(org.xml.sax.Locator)
, Locator
public void startDocument() throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、文書の先頭で特殊なアクション (ツリーのルートノードの割り当て、出力ファイルの作成など) を実行できます。
startDocument
、インタフェース: ContentHandler
SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.startDocument()
public void endDocument() throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、文書の終わりで特殊なアクション (ツリーのファイナライズ、出力ファイルの終了など) を実行できます。
endDocument
、インタフェース: ContentHandler
SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.endDocument()
public void startPrefixMapping(String prefix, String uri) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、各名前空間接頭辞のスコープの開始位置で特定のアクション (接頭辞のマッピングの格納など) を実行できます。
startPrefixMapping
、インタフェース: ContentHandler
prefix
- 宣言される名前空間接頭辞。uri
- 接頭辞にマッピングされた名前空間 URI。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
public void endPrefixMapping(String prefix) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内でこのメソッドをオーバーライドして、個々の接頭辞の終了位置で特定のアクションを実行できます。
endPrefixMapping
、インタフェース: ContentHandler
prefix
- 宣言される名前空間接頭辞。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.endPrefixMapping(java.lang.String)
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各要素の先頭で特殊なアクション (新しいツリーノードの割り当て、出力内容のファイルへの書き込みなど) を実行できます。名前空間 URI。
startElement
、インタフェース: ContentHandler
uri
- 名前空間 URI。要素が名前空間 URI を持たない場合、または名前空間処理が実行されない場合は空文字列。localName
- 接頭辞なしのローカル名。名前空間処理が実行されない場合は空文字列。qName
- 接頭辞付きの修飾名。修飾名を使用できない場合は空文字列。attributes
- 要素に付加された属性。属性が存在しない場合、空の Attributes オブジェクト。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void endElement(String uri, String localName, String qName) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各要素の終わりで特殊なアクション (ツリーノードのファイナライズ、出力内容のファイルへの書き込みなど) を実行できます。
endElement
、インタフェース: ContentHandler
uri
- 名前空間 URI。要素が名前空間 URI を持たない場合、または名前空間処理が実行されない場合は空文字列。localName
- 接頭辞なしのローカル名。名前空間処理が実行されない場合は空文字列。qName
- 接頭辞付きの修飾名。修飾名を使用できない場合は空文字列。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
public void characters(char[] ch, int start, int length) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、このメソッドをオーバーライドして、各文字データチャンクに対して特殊なアクション (ノードまたはバッファーへのデータの追加、データのファイルへの出力など) を実行できます。
characters
、インタフェース: ContentHandler
ch
- 文字。start
- 文字配列内の開始位置。length
- 文字配列から使用される文字数。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.characters(char[], int, int)
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、このメソッドをオーバーライドして、無視できる空白文字の各チャンクに対して特殊なアクション (ノードまたはバッファーへのデータの追加、データのファイルへの出力など) を実行できます。
ignorableWhitespace
、インタフェース: ContentHandler
ch
- 空白文字。start
- 文字配列内の開始位置。length
- 文字配列から使用される文字数。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.ignorableWhitespace(char[], int, int)
public void processingInstruction(String target, String data) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各処理命令に対して特殊なアクション (ステータス変数の設定、その他のメソッドの呼び出しなど) を実行できます。
processingInstruction
、インタフェース: ContentHandler
target
- 処理命令のターゲット。data
- 処理命令データ。データが提供されない場合は null。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.processingInstruction(java.lang.String, java.lang.String)
public void skippedEntity(String name) throws SAXException
デフォルトでは何も行いません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各処理命令に対して特殊なアクション (ステータス変数の設定、その他のメソッドの呼び出しなど) を実行できます。
skippedEntity
、インタフェース: ContentHandler
name
- スキップされたエンティティーの名前。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ContentHandler.processingInstruction(java.lang.String, java.lang.String)
public void warning(SAXParseException e) throws SAXException
デフォルト実装は何も実行しません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各警告に対して特殊なアクション (ログファイルへのメッセージの挿入、メッセージのコンソールへの出力など) を実行できます。
warning
、インタフェース: ErrorHandler
e
- 例外としてエンコードされた警告情報。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ErrorHandler.warning(org.xml.sax.SAXParseException)
, SAXParseException
public void error(SAXParseException e) throws SAXException
デフォルト実装は何も実行しません。アプリケーションの作成者は、サブクラス内のこのメソッドをオーバーライドして、各エラーに対して特殊なアクション (ログファイルへのメッセージの挿入、メッセージのコンソールへの出力など) を実行できます。
error
、インタフェース: ErrorHandler
e
- 例外としてエンコードされたエラー情報。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ErrorHandler.warning(org.xml.sax.SAXParseException)
, SAXParseException
public void fatalError(SAXParseException e) throws SAXException
デフォルトの実装では SAXParseException をスローします。アプリケーションの作成者は、個々の致命的なエラーに対して特殊なアクションをとる (すべてのエラーを単一の報告にまとめるなど) 必要がある場合、サブクラス内のこのメソッドをオーバーライドできます。このメソッドが呼び出されると、文書の信頼性が低くなり、パーサーも構文解析イベントを報告しなくなるので、アプリケーションの通常処理はすべて終了される必要があります。
fatalError
、インタフェース: ErrorHandler
e
- 例外としてエンコードされたエラー情報。SAXException
- 任意の SAX 例外。ほかの例外をラップしている可能性があります。ErrorHandler.fatalError(org.xml.sax.SAXParseException)
, SAXParseException
バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.