Интерфейс 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), COMMENT или PROCESSING_INSTRUCTION, пока не будет достигнут START_ELEMENT или END_ELEMENT. Если встречены другие символы, кроме пробелов, COMMENT, PROCESSING_INSTRUCTION, 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' связан, как определено в спецификации Пространства имён в 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)

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

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, значение COMMENT, значение замены для 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», Length должен быть больше 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()

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