Spec-Zone.ru › OpenJDK 24

Интерфейс распознавания интерфейса

Все известные подинтерфейсы:
Locator2
Все известные реализующие классы:
Locator2Impl, LocatorImpl
public interface Locator
Интерфейс для сопоставления события SAX с местоположением документа.

Если анализатор SAX предоставляет информацию о местоположении приложению SAX, он делает это, реализуя этот интерфейс, а затем передавая экземпляр приложению с помощью метода обработчика содержимого setDocumentLocator. Приложение может использовать объект для получения местоположения любого другого события SAX в исходном документе XML.

Обратите внимание, что результаты, возвращаемые объектом, будут действительны только в рамках каждого метода обратного вызова: приложение получит непредсказуемые результаты, если попытается использовать локатор в любое другое время или после завершения анализа.

Анализаторы SAX не обязаны предоставлять локатор, но их очень настоятельно рекомендуют это сделать. Если анализатор предоставляет локатор, он должен сделать это до сообщения о любых других событиях документа. Если локатор не был установлен к тому моменту, когда приложение получает событие startDocument, приложение должно предположить, что локатор недоступен.

С:
1.4, SAX 1.0
См. также:
  • ContentHandler.setDocumentLocator(org.xml.sax.Locator)

Краткое описание методов

Модификатор и тип Метод Описание
int getColumnNumber()
Возвращает номер столбца, где заканчивается текущее событие документа.
int getLineNumber()
Возвращает номер строки, где заканчивается текущее событие документа.
String getPublicId()
Возвращает общедоступный идентификатор для текущего события документа.
String getSystemId()
Возвращает системный идентификатор для текущего события документа.

Подробное описание методов

getPublicId

String getPublicId()
Возвращает общедоступный идентификатор для текущего события документа.

Возвращаемое значение — общедоступный идентификатор сущности документа или внешней анализируемой сущности, в которой появляется разметка, вызывающая событие.

Возвращает:
Строка, содержащая общедоступный идентификатор, или null, если он недоступен.
См. также:
  • getSystemId()

getSystemId

String getSystemId()
Возвращает системный идентификатор для текущего события документа.

Возвращаемое значение — системный идентификатор сущности документа или внешней анализируемой сущности, в которой появляется разметка, вызывающая событие.

Если системный идентификатор — URL, анализатор должен полностью разрешить его, прежде чем передать его приложению. Например, имя файла всегда должно предоставляться в виде URL file:..., а другие виды относительных URI также разрешаются относительно их оснований.

Возвращает:
Строка, содержащая системный идентификатор, или null, если он недоступен.
См. также:
  • getPublicId()

getLineNumber

int getLineNumber()
Возвращает номер строки, где заканчивается текущее событие документа. Строки разделяются концами строк, которые определены в спецификации XML.

Предупреждение: Возвращаемое значение метода предназначено только для приблизительной диагностики; оно не предназначено для предоставления достаточной информации для редактирования исходного содержимого XML-документа. В некоторых случаях эти номера "строк" соответствуют тому, что отображалось бы как столбцы, а в других они могут не совпадать с исходным текстом из-за расширения внутренних сущностей.

Возвращаемое значение — приблизительное значение номера строки в сущности документа или внешней анализируемой сущности, где появляется разметка, вызывающая событие.

Если возможно, драйвер SAX должен предоставить позицию строки первого символа после текста, связанного с событием документа. Первая строка — строка 1.

Возвращает:
Номер строки или -1, если он недоступен.
См. также:
  • getColumnNumber()

getColumnNumber

int getColumnNumber()
Возвращает номер столбца, где заканчивается текущее событие документа. Это однобазовое число Java char значений с момента последнего конца строки.

Предупреждение: Возвращаемое значение метода предназначено только для приблизительной диагностики; оно не предназначено для предоставления достаточной информации для редактирования исходного содержимого XML-документа. Например, при строках, содержащих последовательности сочетания символов, широкие символы, пары суррогатов или текст с двунаправленной ориентацией, значение может не соответствовать столбцу в отображении текстового редактора.

Возвращаемое значение — приблизительное значение номера столбца в сущности документа или внешней анализируемой сущности, где появляется разметка, вызывающая событие.

Если возможно, драйвер SAX должен предоставить позицию строки первого символа после текста, связанного с событием документа. Первый столбец в каждой строке — столбец 1.

Возвращает:
Номер столбца или -1, если он недоступен.
См. также:
  • getLineNumber()

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.xml/org/xml/sax/Locator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API