Интерфейс XMLStreamReader

Object getProperty(String name) throws IllegalArgumentException

Параметры:

name - Имя свойства, не может быть null

Возвращает:

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

Исключение:

IllegalArgumentException - если имя равно null

int next() throws XMLStreamException

Возвращает:

целочисленный код, соответствующий текущему событию парсинга

Исключение:

NoSuchElementException - если это вызов, когда hasNext() возвращает false

XMLStreamException - если при обработке исходного XML-источника произошла ошибка

См. также:

• XMLEvent

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

Параметры:

type - тип события

namespaceURI - пространство имён события, может быть null

localName - локальное имя события, может быть null

Исключение:

XMLStreamException - если необходимые значения не совпадают.

String getElementText() throws XMLStreamException

 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();
 

Возвращает:

содержимое элемента, содержащего только текст

Исключение:

XMLStreamException - если текущее событие не START_ELEMENT или встречается элемент, не содержащий текст

int nextTag() throws XMLStreamException

 
 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; 
 

Возвращает:

тип события элемента (START_ELEMENT или END_ELEMENT)

Исключение:

XMLStreamException - если текущее событие не является пробелом, PROCESSING_INSTRUCTION, START_ELEMENT или END_ELEMENT

NoSuchElementException - если это вызов, когда hasNext() возвращает false

boolean hasNext() throws XMLStreamException

Возвращает:

true, если есть дополнительные события; иначе false

Исключение:

XMLStreamException - если при обнаружении следующего состояния произошла критическая ошибка

void close() throws XMLStreamException

Исключение:

XMLStreamException - если при освобождении связанных ресурсов произошли ошибки

String getNamespaceURI(String prefix)

Параметры:

prefix - Префикс для поиска, не может быть null

Возвращает:

пространство имён, связанное с данным префиксом, или null, если оно не связано

Исключение:

IllegalArgumentException - если префикс равен null

boolean isStartElement()

Возвращает:

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

boolean isEndElement()

Возвращает:

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

boolean isCharacters()

Возвращает:

true, если курсор указывает на данные символов; иначе false

boolean isWhiteSpace()

Возвращает:

true, если курсор указывает на все пробелы; иначе false

String getAttributeValue(String namespaceURI, String localName)

Параметры:

namespaceURI - пространство имён атрибута

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

Возвращает:

значение атрибута; возвращает null, если не найден

Исключение:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

int getAttributeCount()

Возвращает:

количество атрибутов

Исключение:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

QName getAttributeName(int index)

Параметры:

index - позиция атрибута

Возвращает:

QName атрибута

Исключение:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

String getAttributeNamespace(int index)

Параметры:

index - позиция атрибута

Возвращает:

URI пространства имён (может быть null)

Исключение:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

String getAttributeLocalName(int index)

Параметры:

index - позиция атрибута

Возвращает:

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

Исключение:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

String getAttributePrefix(int index)

Параметры:

index - позиция атрибута

Возвращает:

префикс атрибута

Исключение:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

String getAttributeType(int index)

Параметры:

index - позиция атрибута

Возвращает:

XML тип атрибута

Выбрасывает:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

String getAttributeValue(int index)

Параметры:

index - позиция атрибута

Возвращает:

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

Выбрасывает:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

boolean isAttributeSpecified(int index)

Параметры:

index - позиция атрибута

Возвращает:

true, если это атрибут по умолчанию

Выбрасывает:

IllegalStateException - если это не START_ELEMENT или ATTRIBUTE

int getNamespaceCount()

Возвращает:

количество объявленных пространств имён в элементе

Выбрасывает:

IllegalStateException - если это не START_ELEMENT, END_ELEMENT или NAMESPACE

String getNamespacePrefix(int index)

Параметры:

index - позиция объявления пространства имён

Возвращает:

префикс пространства имён

Выбрасывает:

IllegalStateException - если это не START_ELEMENT, END_ELEMENT или NAMESPACE

String getNamespaceURI(int index)

Параметры:

index - позиция объявления пространства имён

Возвращает:

URI пространства имён

Выбрасывает:

IllegalStateException - если это не START_ELEMENT, END_ELEMENT или NAMESPACE

NamespaceContext getNamespaceContext()

Возвращает:

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

int getEventType()

Возвращает:

тип текущего события

String getText()

Возвращает:

текущий текст или null

Выбрасывает:

IllegalStateException - если состояние не является допустимым текстовым состоянием.

char[] getTextCharacters()

Возвращает:

текущий текст или пустой массив

Выбрасывает:

IllegalStateException - если состояние не является допустимым текстовым состоянием.

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

 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;
 }
  

Параметры:

sourceStart - индекс первого символа в исходном массиве для копирования

target - целевой массив

targetStart - начальный смещение в целевом массиве

length - количество символов для копирования

Возвращает:

количество фактически скопированных символов

Выбрасывает:

XMLStreamException - если базовый XML-источник не имеет правильного формата

IndexOutOfBoundsException - если targetStart < 0 или > длины target

IndexOutOfBoundsException - если length < 0 или targetStart + length > длины target

UnsupportedOperationException - если этот метод не поддерживается

NullPointerException - если target равно null

int getTextStart()

Возвращает:

начальная позиция текста в массиве символов

Выбрасывает:

IllegalStateException - если состояние не является допустимым текстовым состоянием.

int getTextLength()

Возвращает:

длина текста

Выбрасывает:

IllegalStateException - если состояние не является допустимым текстовым состоянием.

String getEncoding()

Возвращает:

кодировка данного экземпляра или null

boolean hasText()

Возвращает:

true, если событие содержит текст, false в противном случае

Location getLocation()

Возвращает:

расположение курсора

QName getName()

Возвращает:

QName для текущего события START_ELEMENT или END_ELEMENT

Выбрасывает:

IllegalStateException - если это не START_ELEMENT или END_ELEMENT

String getLocalName()

Возвращает:

локальное имя

Выбрасывает:

IllegalStateException - если это не START_ELEMENT, END_ELEMENT или ENTITY_REFERENCE

boolean hasName()

Возвращает:

true, если событие имеет имя, false в противном случае

String getNamespaceURI()

Возвращает:

URI, связанный с префиксом этого элемента, пространством имён по умолчанию или null

String getPrefix()

Возвращает:

префикс или null

String getVersion()

Возвращает:

версию XML или null

boolean isStandalone()

Возвращает:

true, если автономно, или false в противном случае

boolean standaloneSet()

Возвращает:

true, если standalone было установлено в документе, или false в противном случае

String getCharacterEncodingScheme()

Возвращает:

кодировку, объявленную в документе, или null

String getPITarget()

Возвращает:

целевой элемент или null

String getPIData()

Возвращает:

данные или null