Интерфейс Locator

Все известные подинтерфейсы:: Locator2

Все известные реализующие классы:: Locator2Impl, LocatorImpl

public interface Locator

Интерфейс для сопоставления события SAX с местоположением документа.

Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИЙ. См. http://www.saxproject.org для получения дополнительной информации.

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

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

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

С момента:: 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()

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

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

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

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

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

© 1993, 2020, 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.