Интерфейс 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 — URI события, может быть 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

Возвращает:

URI, связанный с указанным префиксом, или 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 — позиция атрибута

Возвращает:

localName атрибута

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

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

Возвращает:

localName

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

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