javax.xml.stream

Интерфейсный XMLStreamWriter

public interface XMLStreamWriter

Интерфейс XMLStreamWriter определяет, как записать XML. XMLStreamWriter не выполняет хорошо formedness проверяющий его ввода. Однако writeCharacters метод обязан выходить &, <и> Для значений атрибута writeAttribute метод выйдет из вышеупомянутых символов плюс, "чтобы гарантировать, что весь символьный контент и значения атрибута хорошо формируются. Каждое ПРОСТРАНСТВО ИМЕН и АТРИБУТ должны быть индивидуально записаны.

XML Пространства имен, javax.xml.stream.isRepairingNamespaces и поведение метода записи
Метод	isRepairingNamespaces == истина		isRepairingNamespaces == ложь
	namespaceURI связывается	несвязанный namespaceURI	namespaceURI связывается	несвязанный namespaceURI
writeAttribute(namespaceURI, localName, value)	prefix:localName = "значение" [1]	xmlns: {сгенерированный} = "namespaceURI" {генерировал}:localName = "значение"	prefix:localName = "значение" [1]	XMLStreamException
writeAttribute(prefix, namespaceURI, localName, value)	связанный с тем же самым префиксом: prefix:localName = "значение" [1] связанный с различным префиксом: xmlns: {сгенерированный} = "namespaceURI" {генерировал}:localName = "значение"	xmlns:prefix = "namespaceURI" prefix:localName = "значение" [3]	связанный с тем же самым префиксом: prefix:localName = "значение" [1] [2] связанный с различным префиксом: XMLStreamException[2]	xmlns:prefix = "namespaceURI" prefix:localName = "значение" [2] [5]
writeStartElement(namespaceURI, localName) writeEmptyElement(namespaceURI, localName)	<prefix:localName> [1]	<{сгенерированный}:localName xmlns: {сгенерированный} = "namespaceURI">	<prefix:localName> [1]	XMLStreamException
writeStartElement(prefix, localName, namespaceURI) writeEmptyElement(prefix, localName, namespaceURI)	связанный с тем же самым префиксом: <prefix:localName> [1] связанный с различным префиксом: <{сгенерированный}:localName xmlns: {сгенерированный} = "namespaceURI">	<prefix:localName xmlns:prefix = "namespaceURI"> [4]	связанный с тем же самым префиксом: <prefix:localName> [1] связанный с различным префиксом: XMLStreamException	<prefix:localName>
Примечания: [1] если namespaceURI == URI пространства имен по умолчанию, то никакой префикс не пишется [2] если префикс == ""|| нуль && namespaceURI =="", тогда никакое префиксное или Объявление пространства имен не сгенерировано или записано [3] если префикс == "" || нуль, то префикс в произвольном порядке сгенерирован [4] если префикс == "" || нуль, то это обрабатывается как пространство имен по умолчанию и никакой префикс, сгенерирован или записан, xmlns объявление сгенерировано и записано, если namespaceURI несвязанный [5] если префикс == "" || нуль, то это обрабатывается как недопустимая попытка определить пространство имен по умолчанию и XMLStreamException, бросается

С тех пор:

1.6

См. Также:

XMLOutputFactory, XMLStreamReader

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
void	close() Закройте этого писателя и свободный любые ресурсы, связанные с писателем.
void	flush() Запишите любые кэшированные данные в базовый выходной механизм.
NamespaceContext	getNamespaceContext() Возвращает текущий контекст пространства имен.
Строка	getPrefix(String uri) Получает префикс, с которым связываются туры
Объект	getProperty(String name) Получите значение функции/свойства от базовой реализации
void	setDefaultNamespace(String uri) Связывает URI с пространством имен по умолчанию, Этот URI связывается в пределах текущего START_ELEMENT / пара END_ELEMENT.
void	setNamespaceContext(NamespaceContext context) Устанавливает текущий контекст пространства имен для привязки туров и префикса.
void	setPrefix(String prefix, String uri) Устанавливает префикс, с которым связываются туры.
void	writeAttribute(String localName, String value) Пишет атрибут в поток вывода без префикса.
void	writeAttribute(String namespaceURI, String localName, String value) Пишет атрибут в поток вывода
void	writeAttribute(String prefix, String namespaceURI, String localName, String value) Пишет атрибут в поток вывода
void	writeCData(String data) Пишет раздел CData
void	writeCharacters(char[] text, int start, int len) Запишите текст в вывод
void	writeCharacters(String text) Запишите текст в вывод
void	writeComment(String data) Пишет комментарий xml с включенными данными
void	writeDefaultNamespace(String namespaceURI) Пишет пространство имен по умолчанию в поток
void	writeDTD(String dtd) Запишите раздел DTD.
void	writeEmptyElement(String localName) Пишет пустой тег элемента в вывод
void	writeEmptyElement(String namespaceURI, String localName) Пишет пустой тег элемента в вывод
void	writeEmptyElement(String prefix, String localName, String namespaceURI) Пишет пустой тег элемента в вывод
void	writeEndDocument() Завершения любой запускает теги, и пишет соответствующие конечные тэги.
void	writeEndElement() Пишет конечный тэг в вывод, полагающийся на внутреннее состояние писателя, чтобы определить префиксное и локальное имя события.
void	writeEntityRef(String name) Пишет ссылка на сущность
void	writeNamespace(String prefix, String namespaceURI) Пишет пространство имен в поток вывода, Если префиксным параметром этому методу будет пустая строка, "xmlns", или обнулите этот метод, то делегирует к writeDefaultNamespace
void	writeProcessingInstruction(String target) Пишет инструкция обработки
void	writeProcessingInstruction(String target, String data) Пишет инструкция обработки
void	writeStartDocument() Запишите XML Объявление.
void	writeStartDocument(String version) Запишите XML Объявление.
void	writeStartDocument(String encoding, String version) Запишите XML Объявление.
void	writeStartElement(String localName) Пишет тег запуска в вывод.
void	writeStartElement(String namespaceURI, String localName) Пишет тег запуска в вывод
void	writeStartElement(String prefix, String localName, String namespaceURI) Пишет тег запуска в вывод

Деталь метода

writeStartElement

void writeStartElement(String localName)
                       throws XMLStreamException

Пишет тег запуска в вывод. Все writeStartElement методы открывают новый контекст во внутреннем контексте пространства имен. Запись соответствующего EndElement заставляет контекст быть закрытым.

Параметры:

localName - локальное имя тега, возможно, не нуль

Броски:

XMLStreamException

writeStartElement

void writeStartElement(String namespaceURI,
                     String localName)
                       throws XMLStreamException

Пишет тег запуска в вывод

Параметры:

namespaceURI - namespaceURI префикса, чтобы использовать, возможно, не нуль

localName - локальное имя тега, возможно, не нуль

Броски:

XMLStreamException - если URI пространства имен не был связан с префиксом, и javax.xml.stream.isRepairingNamespaces не был установлен в истину

writeStartElement

void writeStartElement(String prefix,
                     String localName,
                     String namespaceURI)
                       throws XMLStreamException

Пишет тег запуска в вывод

Параметры:

localName - локальное имя тега, возможно, не нуль

prefix - префикс тега, возможно, не нуль

namespaceURI - туры, чтобы связать префикс с, возможно, не нуль

Броски:

XMLStreamException

writeEmptyElement

void writeEmptyElement(String namespaceURI,
                     String localName)
                       throws XMLStreamException

Пишет пустой тег элемента в вывод

Параметры:

namespaceURI - туры, чтобы связать тег с, возможно, не нуль

localName - локальное имя тега, возможно, не нуль

Броски:

XMLStreamException - если URI пространства имен не был связан с префиксом, и javax.xml.stream.isRepairingNamespaces не был установлен в истину

writeEmptyElement

void writeEmptyElement(String prefix,
                     String localName,
                     String namespaceURI)
                       throws XMLStreamException

Пишет пустой тег элемента в вывод

Параметры:

prefix - префикс тега, возможно, не нуль

localName - локальное имя тега, возможно, не нуль

namespaceURI - туры, чтобы связать тег с, возможно, не нуль

Броски:

XMLStreamException

writeEmptyElement

void writeEmptyElement(String localName)
                       throws XMLStreamException

Пишет пустой тег элемента в вывод

Параметры:

localName - локальное имя тега, возможно, не нуль

Броски:

XMLStreamException

writeEndElement

void writeEndElement()
                     throws XMLStreamException

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

Броски:

XMLStreamException

writeEndDocument

void writeEndDocument()
                      throws XMLStreamException

Завершения любой запускает теги, и пишет соответствующие конечные тэги.

Броски:

XMLStreamException

близко

void close()
           throws XMLStreamException

Закройте этого писателя и свободный любые ресурсы, связанные с писателем. Это не должно закрыть базовый поток вывода.

Броски:

XMLStreamException

сброс

void flush()
           throws XMLStreamException

Запишите любые кэшированные данные в базовый выходной механизм.

Броски:

XMLStreamException

writeAttribute

void writeAttribute(String localName,
                  String value)
                    throws XMLStreamException

Пишет атрибут в поток вывода без префикса.

Параметры:

localName - локальное имя атрибута

value - значение атрибута

Броски:

IllegalStateException - если текущее состояние не позволяет запись Атрибута

XMLStreamException

writeAttribute

void writeAttribute(String prefix,
                  String namespaceURI,
                  String localName,
                  String value)
                    throws XMLStreamException

Пишет атрибут в поток вывода

Параметры:

prefix - префикс для этого атрибута

namespaceURI - туры префикса для этого атрибута

localName - локальное имя атрибута

value - значение атрибута

Броски:

IllegalStateException - если текущее состояние не позволяет запись Атрибута

XMLStreamException - если URI пространства имен не был связан с префиксом, и javax.xml.stream.isRepairingNamespaces не был установлен в истину

writeAttribute

void writeAttribute(String namespaceURI,
                  String localName,
                  String value)
                    throws XMLStreamException

Пишет атрибут в поток вывода

Параметры:

namespaceURI - туры префикса для этого атрибута

localName - локальное имя атрибута

value - значение атрибута

Броски:

IllegalStateException - если текущее состояние не позволяет запись Атрибута

XMLStreamException - если URI пространства имен не был связан с префиксом, и javax.xml.stream.isRepairingNamespaces не был установлен в истину

writeNamespace

void writeNamespace(String prefix,
                  String namespaceURI)
                    throws XMLStreamException

Пишет пространство имен в поток вывода, Если префиксным параметром этому методу будет пустая строка, "xmlns", или обнулите этот метод, то делегирует к writeDefaultNamespace

Параметры:

prefix - префикс, чтобы связать это пространство имен с

namespaceURI - туры, чтобы связать префикс с

Броски:

IllegalStateException - если текущее состояние не позволяет запись Пространства имен

XMLStreamException

writeDefaultNamespace

void writeDefaultNamespace(String namespaceURI)
                           throws XMLStreamException

Пишет пространство имен по умолчанию в поток

Параметры:

namespaceURI - туры, чтобы связать пространство имен по умолчанию с

Броски:

IllegalStateException - если текущее состояние не позволяет запись Пространства имен

XMLStreamException

writeComment

void writeComment(String data)
                  throws XMLStreamException

Пишет комментарий xml с включенными данными

Параметры:

data - данные, содержавшиеся в комментарии, могут быть нулем

Броски:

XMLStreamException

writeProcessingInstruction

void writeProcessingInstruction(String target)
                                throws XMLStreamException

Пишет инструкция обработки

Параметры:

target - цель инструкции обработки, возможно, не нуль

Броски:

XMLStreamException

writeProcessingInstruction

void writeProcessingInstruction(String target,
                              String data)
                                throws XMLStreamException

Пишет инструкция обработки

Параметры:

target - цель инструкции обработки, возможно, не нуль

data - данные, содержавшиеся в инструкции обработки, возможно, не нуль

Броски:

XMLStreamException

writeCData

void writeCData(String data)
                throws XMLStreamException

Пишет раздел CData

Параметры:

data - данные, содержавшиеся в Разделе CData, возможно, не нуль

Броски:

XMLStreamException

writeDTD

void writeDTD(String dtd)
              throws XMLStreamException

Запишите раздел DTD. Эта строка представляет все doctypedecl производство от спецификации XML 1.0.

Параметры:

dtd - DTD, который будет записан

Броски:

XMLStreamException

writeEntityRef

void writeEntityRef(String name)
                    throws XMLStreamException

Пишет ссылка на сущность

Параметры:

name - имя объекта

Броски:

XMLStreamException

writeStartDocument

void writeStartDocument()
                        throws XMLStreamException

Запишите XML Объявление. Принимает значение по умолчанию версия XML к 1.0, и кодирование к utf-8

Броски:

XMLStreamException

writeStartDocument

void writeStartDocument(String version)
                        throws XMLStreamException

Запишите XML Объявление. Принимает значение по умолчанию версия XML к 1.0

Параметры:

version - версия xml документа

Броски:

XMLStreamException

writeStartDocument

void writeStartDocument(String encoding,
                      String version)
                        throws XMLStreamException

Запишите XML Объявление. Отметьте, что параметр кодирования не устанавливает фактическое кодирование базового вывода. Это должно быть установлено, когда экземпляр XMLStreamWriter создается, используя XMLOutputFactory

Параметры:

encoding - кодирование xml объявления

version - версия xml документа

Броски:

XMLStreamException - Если дано кодирование не соответствует кодирование базового потока

writeCharacters

void writeCharacters(String text)
                     throws XMLStreamException

Запишите текст в вывод

Параметры:

text - значение, чтобы записать

Броски:

XMLStreamException

writeCharacters

void writeCharacters(char[] text,
                   int start,
                   int len)
                     throws XMLStreamException

Запишите текст в вывод

Параметры:

text - значение, чтобы записать

start - стартовая позиция в массиве

len - число символов, чтобы записать

Броски:

XMLStreamException

getPrefix

String getPrefix(String uri)
                 throws XMLStreamException

Получает префикс, с которым связываются туры

Возвраты:

префикс или нуль

Броски:

XMLStreamException

setPrefix

void setPrefix(String prefix,
             String uri)
               throws XMLStreamException

Устанавливает префикс, с которым связываются туры. Этот префикс связывается в пределах текущего START_ELEMENT / пара END_ELEMENT. Если этот метод вызывают прежде, чем START_ELEMENT был записан, префикс связывается в корневом контексте.

Параметры:

prefix - префикс, чтобы связать с турами, возможно, не нуль

uri - туры, чтобы связать с префиксом, может быть нуль

Броски:

XMLStreamException

setDefaultNamespace

void setDefaultNamespace(String uri)
                         throws XMLStreamException

Связывает URI с пространством имен по умолчанию, Этот URI связывается в пределах текущего START_ELEMENT / пара END_ELEMENT. Если этот метод вызывают прежде, чем START_ELEMENT был записан, туры связывается в корневом контексте.

Параметры:

uri - туры, чтобы связать с пространством имен по умолчанию, может быть нуль

Броски:

XMLStreamException

setNamespaceContext

void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Устанавливает текущий контекст пространства имен для привязки туров и префикса. Этот контекст становится корневым контекстом пространства имен для того, чтобы записать и заменит текущий корневой контекст пространства имен. Последующие звонки setPrefix и setDefaultNamespace свяжут пространства имен, используя контекст, который передают к методу как корневой контекст для того, чтобы разрешить пространства имен. Однажды этот метод можно только вызвать в начале документа. Это не заставляет пространства имен быть объявленными. Если URI пространства имен, чтобы снабдить префиксом отображение находится в контексте пространства имен, это обрабатывается как объявлено, и префикс может использоваться StreamWriter.

Параметры:

context - контекст пространства имен, чтобы использовать для этого писателя, возможно, не нуль

Броски:

XMLStreamException

getNamespaceContext

NamespaceContext getNamespaceContext()

Возвращает текущий контекст пространства имен.

Возвраты:

текущий NamespaceContext

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException

Получите значение функции/свойства от базовой реализации

Параметры:

name - Имя свойства, возможно, не нуль

Возвраты:

Значение свойства

Броски:

IllegalArgumentException - если свойство не поддерживается

NullPointerException - если имя является нулем