Интерфейс Locator

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

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

public interface Locator

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

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

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

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

Начиная с версии:

1.4, SAX 1.0

См. также:

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

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

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

getPublicId

String getPublicId()

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

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

Возвращает:

Строку с публичным идентификатором или null, если он недоступен.

См. также:

getSystemId

String getSystemId()

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

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

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

Возвращает:

Строку с системным идентификатором или null, если он недоступен.

См. также:

getLineNumber

int getLineNumber()

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

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

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

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

Возвращает:

Номер строки или -1, если он недоступен.

См. также:

getColumnNumber

int getColumnNumber()

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

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

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

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

Возвращает:

Номер столбца или -1, если он недоступен.

См. также:

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.xml/org/xml/sax/Locator.html