org.xml.sax.ext

インタフェース Locator2

すべてのスーパーインタフェース:

Locator

既知のすべての実装クラス:

Locator2Impl

public interface Locator2
extends Locator

SAX2 拡張は Locator を通して提供されるエンティティー情報を増やします。実装がこの拡張をサポートしている場合、ContentHandler.setDocumentLocator() で提供されるロケータはこのインタフェースを実装し、http://xml.org/sax/features/use-locator2 機能フラグは値 true を持ちます。

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

XMLReader 実装はこの情報のサポートに必要ありません。これは SAX2 のコアディストリビューションだけに含まれるものではありません。

導入されたバージョン:

SAX 2.0 (extensions 1.1 alpha)

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getEncoding() エンティティーの文字エンコーディングの名前を返します。
String	getXMLVersion() エンティティーに使用される XML のバージョンを返します。

インタフェース org.xml.sax.Locator から継承されたメソッド

getColumnNumber, getLineNumber, getPublicId, getSystemId

メソッドの詳細

getXMLVersion

String getXMLVersion()

エンティティーに使用される XML のバージョンを返します。通常、これは現在のエンティティーの <?xml version='...' ...?> 宣言からの識別子になるか、パーサーによってデフォルトで設定されます。

戻り値:

エンティティーのテキスト解釈に使用されている XML バージョンの識別子。その情報が現在の構文解析状態ではまだ使用できない場合は null。

getEncoding

String getEncoding()

エンティティーの文字エンコーディングの名前を返します。エンコーディングが外部 (たとえば MIME Content-Type ヘッダー) で宣言された場合は、返された名前になります。あるいは、文書の開始位置で <?xml ...encoding='...'?> 宣言があった場合、そのエンコーディング名が返されます。そうでない場合は、エンコーディングは推定されるか (通常は UTF-8 または一部が UTF-16 バリアントになる)、推定された名前が返されます。

InputSource を使用してエンティティーの文字ストリームを提供する場合、このメソッドはその入力ストリームで提供されたエンコーディングを返します。

最近の W3C 仕様では、「Unicode Normalization Form C」を使用して、一部エンコーディングが行われているテキストを処理する前に正規化する必要があります。このような正規化はアプリケーションで実行しなければならず、通常はこのメソッドによって返された値に基づいてトリガーされます。

エンコーディング名は背後の JVM で使用されているもので、比較するには大文字と小文字を区別する必要があります。

戻り値:

* エンティティーのテキスト解釈に使用されている文字エンコーディングの名前。InputSource を通して渡された * 文字ストリームに提供されなかった場合、あるいは現在の解析状態ではまだ使用できない場合は null。