Интерфейс XMLStreamReader

Object getProperty(String name) throws IllegalArgumentException

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

int next() throws XMLStreamException

Получить следующий элемент разбора — процессор может вернуть все смежные символьные данные в одном фрагменте или разбить их на несколько фрагментов. Если свойство javax.xml.stream.isCoalescing установлено в значение true, содержимое элемента должно быть слито, и для смежного содержимого элемента или секций CDATA должен быть возвращен только один элемент CHARACTERS. По умолчанию ссылки на сущности должны расширяться и прозрачно сообщаться приложению. Исключение будет брошено, если ссылку на сущность нельзя расширить. Если содержимое элемента пустое (т.е. содержимое ""), то событие CHARACTERS не будет сообщено.

Рассмотрим следующий XML:
<foo><!--description-->content text<![CDATA[<greeting>Hello>/greeting>]]>other content>/foo>
Поведение вызова next() при нахождении foo будет следующим:
1- комментарий (COMMENT)
2- затем раздел символов (CHARACTERS)
3- затем раздел CDATA (еще один CHARACTERS)
4- затем следующий раздел символов (еще один CHARACTERS)
5- затем END_ELEMENT

ПРИМЕЧАНИЕ: пустой элемент (например, <tag/>) будет сообщен с двумя отдельными событиями: START_ELEMENT, END_ELEMENT — это сохраняет эквивалентность разбора пустого элемента с <tag></tag>.

void require(int type, String namespaceURI, String localName) throws XMLStreamException

Проверяет, является ли текущее событие заданного типа, и совпадают ли пространство имен и имя с текущим пространством имен и имен текущего события. Если namespaceURI равно null, оно не проверяется на равенство; если localName равно null, оно не проверяется на равенство.

String getElementText() throws XMLStreamException

Считывает содержимое элемента только с текстом; если это не элемент только с текстом, генерируется исключение. Независимо от значения javax.xml.stream.isCoalescing этот метод всегда возвращает объединенное содержимое.
Предварительное условие: текущее событие — START_ELEMENT.
Последующее условие: текущее событие — соответствующее END_ELEMENT.
Метод выполняет следующие действия (реализации могут быть оптимизированы, но должны выполнять эквивалентную обработку):

 if(getEventType() != XMLStreamConstants.START_ELEMENT) {
     throw new XMLStreamException(
     "parser must be on START_ELEMENT to read next text", getLocation());
 }

 int eventType = next();
 StringBuffer content = new StringBuffer();
 while(eventType != XMLStreamConstants.END_ELEMENT) {
     if(eventType == XMLStreamConstants.CHARACTERS
        || eventType == XMLStreamConstants.CDATA
        || eventType == XMLStreamConstants.SPACE
        || eventType == XMLStreamConstants.ENTITY_REFERENCE) {
           buf.append(getText());
     } else if(eventType == XMLStreamConstants.PROCESSING_INSTRUCTION
               || eventType == XMLStreamConstants.COMMENT) {
         // skipping
     } else if(eventType == XMLStreamConstants.END_DOCUMENT) {
         throw new XMLStreamException(
         "unexpected end of document when reading element text content", this);
     } else if(eventType == XMLStreamConstants.START_ELEMENT) {
         throw new XMLStreamException(
         "element text content may not contain START_ELEMENT", getLocation());
     } else {
         throw new XMLStreamException(
         "Unexpected event type "+eventType, getLocation());
     }
     eventType = next();
 }
 return buf.toString();
 

int nextTag() throws XMLStreamException

Пропускает все пробелы (isWhiteSpace() возвращает true), комментарии или инструкции обработки, пока не будет достигнут START_ELEMENT или END_ELEMENT. Если обнаружено что-то другое, кроме пробелов, комментариев, инструкций обработки, START_ELEMENT или END_ELEMENT, генерируется исключение. Этот метод следует использовать при обработке содержимого только элементов, разделенных пробелами.
Предварительное условие: нет
Последующее условие: текущее событие — START_ELEMENT или END_ELEMENT, курсор может быть перемещен через любое событие пробелов.
В сущности, он делает следующее (реализации могут быть оптимизированы, но должны выполнять эквивалентную обработку):

 
 int eventType = next();
 while((eventType == XMLStreamConstants.CHARACTERS && isWhiteSpace()) // skip whitespace
 || (eventType == XMLStreamConstants.CDATA && isWhiteSpace())
 // skip whitespace
 || eventType == XMLStreamConstants.SPACE
 || eventType == XMLStreamConstants.PROCESSING_INSTRUCTION
 || eventType == XMLStreamConstants.COMMENT
 ) {
     eventType = next();
 }
 if (eventType != XMLStreamConstants.START_ELEMENT && eventType != XMLStreamConstants.END_ELEMENT) {
     throw new String XMLStreamException("expected start or end tag", getLocation());
 }
 return eventType; 
 

boolean hasNext() throws XMLStreamException

Возвращает true, если есть больше событий разбора, и false, если больше событий нет. Этот метод вернет false, если текущее состояние XMLStreamReader — END_DOCUMENT

void close() throws XMLStreamException

Освобождает все ресурсы, связанные с этим читателем. Этот метод не закрывает базовый источник ввода.

String getNamespaceURI(String prefix)

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

ПРИМЕЧАНИЕ: Префикс 'xml' связан, как определено в спецификации Namespaces in XML, со значением "http://www.w3.org/XML/1998/namespace".

ПРИМЕЧАНИЕ: Префикс 'xmlns' должен быть разрешен в следующем пространстве имен http://www.w3.org/2000/xmlns/

boolean isStartElement()

Возвращает true, если курсор указывает на открывающий тег (иначе false)

boolean isEndElement()

Возвращает true, если курсор указывает на закрывающий тег (иначе false)

boolean isCharacters()

Возвращает true, если курсор указывает на событие данных символов

boolean isWhiteSpace()

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

String getAttributeValue(String namespaceURI, String localName)

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

int getAttributeCount()

Возвращает количество атрибутов в этом START_ELEMENT, этот метод действителен только для START_ELEMENT или ATTRIBUTE. Это количество не включает определения пространств имен. Индексы атрибутов нумеруются с нуля.

QName getAttributeName(int index)

Возвращает qname атрибута в заданном индексе

String getAttributeNamespace(int index)

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

String getAttributeLocalName(int index)

Возвращает локальное имя атрибута в заданном индексе

String getAttributePrefix(int index)

Возвращает префикс данного атрибута в заданном индексе

String getAttributeType(int index)

Возвращает XML-тип атрибута в заданном индексе

String getAttributeValue(int index)

Возвращает значение атрибута по индексу

boolean isAttributeSpecified(int index)

Возвращает булево значение, указывающее, был ли этот атрибут создан по умолчанию

int getNamespaceCount()

Возвращает количество объявленных пространств имен для данного START_ELEMENT или END_ELEMENT. Этот метод действует только для START_ELEMENT, END_ELEMENT или NAMESPACE. Для END_ELEMENT количество учитывает пространства имён, которые собираются выйти из области видимости. Это эквивалентно информации, сообщённой обратным вызовом SAX для события закрытия элемента.

String getNamespacePrefix(int index)

Возвращает префикс для пространства имён, объявленного по индексу. Возвращает null, если это объявление пространства имён по умолчанию

String getNamespaceURI(int index)

Возвращает URI для пространства имён, объявленного по индексу.

NamespaceContext getNamespaceContext()

Возвращает контекст пространств имён для текущей позиции. Контекст транзиентен и действует только до вызова next(), изменяющего состояние ридера.

int getEventType()

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

String getText()

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

char[] getTextCharacters()

Возвращает массив, содержащий символы из этого события. К этому массиву следует относиться как к неизменяемому и транзиентному. То есть массив будет содержать символы текста до тех пор, пока XMLStreamReader не перейдет к следующему событию. Попытки удержать массив символов после этого момента или изменить его содержимое нарушают контракт данного интерфейса.

int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException

Получает текст, связанный с событиями CHARACTERS, SPACE или CDATA. Текст, начиная с «sourceStart», копируется в «target», начиная с «targetStart». Копируются до «length» символов. Возвращается количество скопированных символов. Аргумент «sourceStart» должен быть больше или равен 0 и меньше или равен количеству символов, связанных с событием. Обычно запрашивается текст, начинающийся с «sourceStart» 0. Если количество скопированных символов меньше «length», то больше текста нет. В противном случае необходимо выполнить последующие вызовы, пока весь текст не будет извлечен. Например:

 int length = 1024;
 char[] myBuffer = new char[ length ];

 for ( int sourceStart = 0 ; ; sourceStart += length )
 {
    int nCopied = stream.getTextCharacters( sourceStart, myBuffer, 0, length );

   if (nCopied < length)
       break;
 }
  

XMLStreamException может быть брошен, если в базовом источнике имеются ошибки XML. Аргумент «targetStart» должен быть больше или равен 0 и меньше длины «target». Длина должна быть больше 0, а «targetStart + length» должна быть меньше или равна длине «target».

int getTextStart()

Возвращает смещение в массиве символов текста, где хранится первый символ (этого события текста).

int getTextLength()

Возвращает длину последовательности символов для этого события Text в массиве символов текста.

String getEncoding()

Возвращает кодировку ввода, если известна, или null, если неизвестна.

boolean hasText()

Возвращает булево значение, указывающее, содержит ли текущее событие текст. Следующие события содержат текст: CHARACTERS, DTD, ENTITY_REFERENCE, COMMENT, SPACE

Location getLocation()

Возвращает текущую локацию процессора. Если локация неизвестна, процессор должен вернуть реализацию Location, которая возвращает -1 для локации и null для publicId и systemId. Информация о местоположении действительна только до вызова next().

QName getName()

Возвращает QName для текущего события START_ELEMENT или END_ELEMENT.

String getLocalName()

Возвращает (локальное) имя текущего события. Для START_ELEMENT или END_ELEMENT возвращает (локальное) имя текущего элемента. Для ENTITY_REFERENCE возвращает имя сущности. Текущее событие должно быть START_ELEMENT, END_ELEMENT или ENTITY_REFERENCE.

boolean hasName()

Возвращает булево значение, указывающее, имеет ли текущее событие имя (является ли оно START_ELEMENT или END_ELEMENT).

String getNamespaceURI()

Если текущее событие — START_ELEMENT или END_ELEMENT, этот метод возвращает URI префикса или пространства имён по умолчанию. Возвращает null, если событие не имеет префикса.

String getPrefix()

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

String getVersion()

Получает версию XML, объявленную в декларации XML. Возвращает null, если декларация не указана.

boolean isStandalone()

Получает объявление standalone из декларации XML.

boolean standaloneSet()

Проверяет, было ли установлено значение standalone в документе.

String getCharacterEncodingScheme()

Возвращает кодировку символов, объявленную в XML-декларации. Возвращает null, если кодировка не была объявлена.

String getPITarget()

Получить целевой элемент инструкции обработки.

String getPIData()

Получить раздел данных инструкции обработки.