Spec-Zone.ru › OpenJDK 8

Класс StreamSource

  • java.lang.Object
    • javax.xml.transform.stream.StreamSource
Все реализованные интерфейсы:
Source

public class StreamSource
extends Object
implements Source

Выступает в качестве держателя источника преобразования в виде потока XML-разметки.

Примечание: Из-за внутреннего использования экземпляра Reader или InputStream, экземпляры StreamSource могут быть использованы только один раз.

Поля

Модификатор и тип Поле и описание
static String FEATURE

Если TransformerFactory.getFeature(java.lang.String) возвращает true при передаче этого значения в качестве аргумента, преобразователь поддерживает вход Source данного типа.

Конструкторы

Конструктор и описание
StreamSource()

Конструктор по умолчанию без аргументов.

StreamSource(File f)

Создает StreamSource из файла.

StreamSource(InputStream inputStream)

Создает StreamSource из потока байтов.

StreamSource(InputStream inputStream, String systemId)

Создает StreamSource из потока байтов.

StreamSource(Reader reader)

Создает StreamSource из потока символов.

StreamSource(Reader reader, String systemId)

Создает StreamSource из потока символов.

StreamSource(String systemId)

Создает StreamSource из URL.

Методы

Модификатор и тип Метод и описание
InputStream getInputStream()

Получить поток байтов, установленный с помощью setByteStream.

String getPublicId()

Получить общедоступный идентификатор, установленный с помощью setPublicId.

Reader getReader()

Получить поток символов, установленный с помощью setReader.

String getSystemId()

Получить системный идентификатор, установленный с помощью setSystemId.

void setInputStream(InputStream inputStream)

Установить поток байтов для использования в качестве входных данных.

void setPublicId(String publicId)

Установить общедоступный идентификатор для этого источника.

void setReader(Reader reader)

Установить входные данные в виде потока символов.

void setSystemId(File f)

Установить системный идентификатор из ссылки на файл.

void setSystemId(String systemId)

Установить системный идентификатор для этого источника.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Поля

FEATURE

public static final String FEATURE

Если TransformerFactory.getFeature(java.lang.String) возвращает true при передаче этого значения в качестве аргумента, преобразователь поддерживает вход Source данного типа.

См. также:
Значения константных полей

Конструкторы

StreamSource

public StreamSource()

Конструктор по умолчанию без аргументов. Если используется этот конструктор, и источник Stream не задан с помощью setInputStream(java.io.InputStream inputStream) или setReader(java.io.Reader reader), то Transformer создаст пустой источник InputStream с помощью new InputStream().

См. также:
Transformer.transform(Source xmlSource, Result outputTarget)

StreamSource

public StreamSource(InputStream inputStream)

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

Если этот конструктор используется для обработки стилей, обычно также следует вызвать setSystemId, чтобы можно было разрешать относительные ссылки URI.

Параметры:
inputStream - Действительная ссылка на поток InputStream, содержащий поток XML.

StreamSource

public StreamSource(InputStream inputStream,
                    String systemId)

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

Этот конструктор позволяет установить systemID дополнительно к потоку ввода, что позволяет обрабатывать относительные URI.

Параметры:
inputStream - Действительная ссылка на поток InputStream, содержащий поток XML.
systemId - Должно быть строкой, соответствующей синтаксису URI.

StreamSource

public StreamSource(Reader reader)

Создает StreamSource из потока символов. Обычно следует использовать поток, а не поток символов, чтобы парсер XML мог определить кодировку символов, указанную в объявлении XML. Однако во многих случаях кодировка входного потока уже определена, как в случае чтения XML из StringReader.

Параметры:
reader - Действительная ссылка на поток Reader, содержащий поток XML символов.

StreamSource

public StreamSource(Reader reader,
                    String systemId)

Создает StreamSource из потока символов. Обычно следует использовать поток, а не поток символов, чтобы парсер XML мог определить кодировку символов, указанную в объявлении XML. Однако во многих случаях кодировка входного потока уже определена, как в случае чтения XML из StringReader.

Параметры:
reader - Действительная ссылка на поток Reader, содержащий поток XML символов.
systemId - Должно быть строкой, соответствующей синтаксису URI.

StreamSource

public StreamSource(String systemId)

Создает StreamSource из URL.

Параметры:
systemId - Должно быть строкой, соответствующей синтаксису URI.

StreamSource

public StreamSource(File f)

Создает StreamSource из файла.

Параметры:
f - Должна быть ссылка на непустой файл.

Методы

setInputStream

public void setInputStream(InputStream inputStream)

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

Если этот объект Source используется для обработки стилей, обычно также следует вызвать setSystemId, чтобы можно было разрешать относительные ссылки URL.

Параметры:
inputStream - Действительная ссылка на поток InputStream, содержащий поток XML.

getInputStream

public InputStream getInputStream()

Получить поток байтов, установленный с помощью setByteStream.

Возвращает:
Поток байтов, установленный с помощью setByteStream, или null, если setByteStream или конструктор ByteStream не вызывался.

setReader

public void setReader(Reader reader)

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

Параметры:
reader - Действительная ссылка на поток Reader, содержащий поток XML символов.

getReader

public Reader getReader()

Получить поток символов, установленный с помощью setReader.

Возвращает:
Поток символов, установленный с помощью setReader, или null, если setReader или конструктор Reader не вызывался.

setPublicId

public void setPublicId(String publicId)

Установить общедоступный идентификатор для этого источника.

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

Параметры:
publicId - Общедоступный идентификатор в виде строки.

getPublicId

public String getPublicId()

Получить общедоступный идентификатор, установленный с помощью setPublicId.

Возвращает:
Общедоступный идентификатор, установленный с помощью setPublicId, или null, если setPublicId не вызывался.

setSystemId

public void setSystemId(String systemId)

Установить системный идентификатор для этого источника.

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

Определено в:
setSystemId в интерфейсе Source
Параметры:
systemId - Системный идентификатор в виде строки URL.

getSystemId

public String getSystemId()

Получить системный идентификатор, установленный с помощью setSystemId.

Определено в:
getSystemId в интерфейсе Source
Возвращает:
Системный идентификатор, установленный с помощью setSystemId, или null, если setSystemId не вызывался.

setSystemId

public void setSystemId(File f)

Установить системный идентификатор из ссылки на файл.

Параметры:
f - Должна быть ссылка на непустой файл.

© 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.

Spec-Zone.ru

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