Интерфейс LSInput

public interface LSInput

Данный интерфейс представляет собой источник ввода данных.

Этот интерфейс позволяет приложению инкапсулировать информацию об источнике ввода в один объект, который может включать общедоступный идентификатор, системный идентификатор, поток байтов (возможно, с указанной кодировкой), базовый URI и/или поток символов.

Точные определения потока байтов и потока символов зависят от реализации.

Приложение должно предоставлять объекты, реализующие этот интерфейс, при необходимости. Приложение может предоставить собственные объекты, реализующие этот интерфейс, или использовать общий фабричный метод DOMImplementationLS.createLSInput() для создания объектов, реализующих этот интерфейс.

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

LSInput.characterStream
LSInput.byteStream
LSInput.stringData
LSInput.systemId
LSInput.publicId

Если все вводы равны null, LSParser сообщит об ошибке DOMError с его DOMError.type значением "no-input-specified" и его DOMError.severity значением DOMError.SEVERITY_FATAL_ERROR.

Объекты LSInput принадлежат приложению. Реализация DOM никогда их не будет изменять (хотя может создавать копии и изменять копии при необходимости).

См. также Спецификацию загрузки и сохранения DOM (Document Object Model) Level 3.

С момента:: 1.5

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

Модификатор и тип	Метод	Описание
`String`	`getBaseURI()`	Базовый URI, используемый для преобразования относительного `systemId` в абсолютный URI (см. раздел 5.1.4 в [IETF RFC 2396]).
`InputStream`	`getByteStream()`	Атрибут языка и типа, зависящий от реализации, представляющий поток байтов.
`boolean`	`getCertifiedText()`	Если установлено в true, предполагается, что вход сертифицирован (см. раздел 2.13 в [XML 1.1]) при парсинге [XML 1.1].
`Reader`	`getCharacterStream()`	Атрибут языка и типа, зависящий от реализации, представляющий поток 16-битных единиц.
`String`	`getEncoding()`	Кодировка символов, если известна.
`String`	`getPublicId()`	Общедоступный идентификатор для данного источника ввода.
`String`	`getStringData()`	Строка данных для парсинга.
`String`	`getSystemId()`	Системный идентификатор, ссылка на URI [IETF RFC 2396], для данного источника ввода.
`void`	`setBaseURI(String baseURI)`	Базовый URI, используемый для преобразования относительного `systemId` в абсолютный URI (см. раздел 5.1.4 в [IETF RFC 2396]).
`void`	`setByteStream(InputStream byteStream)`	Атрибут языка и типа, зависящий от реализации, представляющий поток байтов.
`void`	`setCertifiedText(boolean certifiedText)`	Если установлено в true, предполагается, что вход сертифицирован (см. раздел 2.13 в [XML 1.1]) при парсинге [XML 1.1].
`void`	`setCharacterStream(Reader characterStream)`	Атрибут языка и типа, зависящий от реализации, представляющий поток 16-битных единиц.
`void`	`setEncoding(String encoding)`	Кодировка символов, если известна.
`void`	`setPublicId(String publicId)`	Общедоступный идентификатор для данного источника ввода.
`void`	`setStringData(String stringData)`	Строка данных для парсинга.
`void`	`setSystemId(String systemId)`	Системный идентификатор, ссылка на URI [IETF RFC 2396], для данного источника ввода.

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

getCharacterStream

Reader getCharacterStream()

Атрибут языка и привязки, представляющий поток 16-битных единиц. Приложение должно кодировать поток с помощью UTF-16 (определено в [Unicode] и в [ISO/IEC 10646]). При использовании потоков символов объявление XML необязательно. Если объявление XML присутствует, значение атрибута encoding будет проигнорировано.

setCharacterStream

void setCharacterStream(Reader characterStream)

getByteStream

InputStream getByteStream()

Атрибут языка и привязки, представляющий поток байтов.
Если приложение знает кодировку символов потока байтов, оно должно установить атрибут encoding. Установка кодировки таким образом переопределит любую кодировку, указанную в объявлении XML в данных.

setByteStream

void setByteStream(InputStream byteStream)

getStringData

String getStringData()

Строковые данные для парсинга. Если предоставлены, они всегда будут обрабатываться как последовательность 16-битных единиц (символы, закодированные в UTF-16). При использовании stringData объявление XML необязательно. Если объявление XML присутствует, значение атрибута encoding будет проигнорировано.

setStringData

void setStringData(String stringData)

getSystemId

String getSystemId()

Идентификатор системы, ссылка URI [IETF RFC 2396], для этого источника ввода. Идентификатор системы необязателен, если есть поток байтов, поток символов или строковые данные. Тем не менее, его полезно предоставить, так как приложение будет использовать его для разрешения любых относительных URI и может включить его в сообщения об ошибках и предупреждениях. (LSParser будет пытаться получить ресурс, идентифицируемый ссылкой URI, только если другой ввод недоступен в источнике ввода.)
Если приложение знает кодировку символов объекта, на который указывает идентификатор системы, оно может установить кодировку с помощью атрибута encoding.
Если указанный идентификатор системы является относительной ссылкой URI (см. раздел 5 в [IETF RFC 2396]), реализация DOM попытается разрешить относительный URI с baseURI в качестве базового, если это не удастся, поведение зависит от реализации.

setSystemId

void setSystemId(String systemId)

getPublicId

String getPublicId()

Публичный идентификатор для этого источника ввода. Он может быть сопоставлен с источником ввода с использованием механизма, зависящего от реализации (например, каталоги или другие сопоставления). Публичный идентификатор, если указан, также может быть включен в информацию о местоположении при сообщении об ошибках.

setPublicId

void setPublicId(String publicId)

getBaseURI

String getBaseURI()

Базовый URI для использования (см. раздел 5.1.4 в [IETF RFC 2396]) для разрешения относительного systemId в абсолютный URI.
Если при использовании базовый URI сам является относительным URI, пустой строкой или null, поведение зависит от реализации.

setBaseURI

void setBaseURI(String baseURI)

getEncoding

String getEncoding()

Кодировка символов, если известна. Кодировка должна быть строкой, допустимой для объявления кодировки XML ([XML 1.0] раздел 4.3.3 "Кодировка символов в сущностях").
Этот атрибут не имеет эффекта, когда приложение предоставляет поток символов или строковые данные. Для других источников ввода кодировка, указанная с помощью этого атрибута, переопределит любую кодировку, указанную в объявлении XML или объявлении Text, или кодировку, полученную из протокола более высокого уровня, такого как HTTP [IETF RFC 2616].

setEncoding

void setEncoding(String encoding)

getCertifiedText

boolean getCertifiedText()

Если установлено в true, предполагается, что вход сертифицирован (см. раздел 2.13 в [XML 1.1]) при парсинге [XML 1.1].

setCertifiedText

void setCertifiedText(boolean certifiedText)

Если установлено в true, предполагается, что вход сертифицирован (см. раздел 2.13 в [XML 1.1]) при парсинге [XML 1.1].

© 1993, 2021, 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/17/docs/api/java.xml/org/w3c/dom/ls/LSInput.html