org.xml.sax.ext
インタフェース DeclHandler

public interface DeclHandler

DTD 宣言イベントのための SAX2 拡張ハンドラです。

このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。

XML 文書中の DTD 宣言に関する情報を提供する SAX2 用の任意の拡張ハンドラです。このハンドラをサポートするために、XML リーダは不要です。また、このハンドラは、SAX2 のコアディストリビューションには含まれていません。

データ関連の DTD 宣言 (未構文解析のエンティティおよび表記法) は、すでに DTDHandler インタフェースによって報告されている点に注意してください。

宣言ハンドラと字句ハンドラを同時に使用する場合、すべてのイベントは startDTD から endDTD までの間に発生します。

DeclHandler を XML リーダに設定するには、propertyId "http://xml.org/sax/properties/declaration-handler" を指定して setProperty メソッドを使用します。リーダが宣言イベントをサポートしない場合、ハンドラを登録しようとすると、SAXNotRecognizedException または SAXNotSupportedException がスローされます。

導入されたバージョン:

1.0

関連項目:

XMLReader

メソッドの概要

void	attributeDecl(String eName, String aName, String type, String valueDefault, String value) 属性型宣言を報告します。
void	elementDecl(String name, String model) 要素型宣言を報告します。
void	externalEntityDecl(String name, String publicId, String systemId) 構文解析済みの外部エンティティ宣言を報告します。
void	internalEntityDecl(String name, String value) 内部エンティティ宣言を報告します。

メソッドの詳細

elementDecl

public void elementDecl(String name,
                        String model)
                 throws SAXException

要素型宣言を報告します。

コンテンツモデルは、文字列 "EMPTY"、文字列 "ANY"、または括弧に入れられたグループ (オプションで出現インジケータを伴う) で構成されます。このモデルは、すべてのパラメータエンティティが完全に解決され、すべての空白文字が削除されるように正規化されます。また、囲む括弧を含みます。その他の正規化 (重複した括弧の削除、出言インジケータの簡易化など) はパーサによって随意行われます。

パラメータ:

name - 要素型名

model - コンテンツモデルを示す正規文字列

例外:

SAXException - アプリケーションが例外を生成することがある

attributeDecl

public void attributeDecl(String eName,
                          String aName,
                          String type,
                          String valueDefault,
                          String value)
                   throws SAXException

属性型宣言を報告します。

有効な (最初の) 属性宣言だけが報告されます。型は、"CDATA"、"ID"、"IDREF"、"IDREFS"、"NMTOKEN"、"NMTOKENS"、"ENTITY"、"ENTITIES"、区切り文字 "|" と削除されたすべての空白文字とともに括弧に入れられたトークングループ、または削除されたすべての空白文字とともに括弧に入れられたトークングループの直前にある空白文字の直前の "NOTATION" という語のいずれかの文字列になります。

通常のエンティティとは異なり、属性値に含まれるパラメータエンティティはすべて拡張されます。

パラメータ:

eName - 関連要素名

aName - 属性の名前

type - 属性型を示す文字列

valueDefault - 属性のデフォルト ("#IMPLIED"、"#REQUIRED"、または "#FIXED") を示す文字列。いずれにも当てはまらない場合は null

value - 属性のデフォルト値を示す文字列。存在しない場合は null

例外:

SAXException - アプリケーションが例外を生成することがある

internalEntityDecl

public void internalEntityDecl(String name,
                               String value)
                        throws SAXException

内部エンティティ宣言を報告します。

有効な (最初の) エンティティ宣言だけが報告されます。通常のエンティティとは異なり、値に含まれるすべてのパラメータエンティティは拡張されます。

パラメータ:

name - エンティティ名。パラメータエンティティの場合、名前は '%' で始まる

value - エンティティの置換テキスト

例外:

SAXException - アプリケーションが例外を生成することがある

関連項目:

externalEntityDecl(java.lang.String, java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

externalEntityDecl

public void externalEntityDecl(String name,
                               String publicId,
                               String systemId)
                        throws SAXException

構文解析済みの外部エンティティ宣言を報告します。

有効な (最初の) エンティティ宣言だけが報告されます。

パラメータ:

name - エンティティ名。パラメータエンティティの場合、名前は '%' で始まる

publicId - 宣言されたエンティティの公開識別子。宣言されていない場合は null

systemId - 宣言されたエンティティのシステム識別子

例外:

SAXException - アプリケーションが例外を生成することがある

関連項目:

internalEntityDecl(java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)