Класс StreamReaderDelegate

public class StreamReaderDelegate
extends Object
implements XMLStreamReader

Конструкторы

StreamReaderDelegate

public StreamReaderDelegate()

Создать пустой фильтр без родителя.

StreamReaderDelegate

public StreamReaderDelegate(XMLStreamReader reader)

Создать фильтр со указанным родителем.

Параметры:

reader - родитель

Методы

setParent

public void setParent(XMLStreamReader reader)

Установить родителя для этого экземпляра.

Параметры:

reader - новый родитель

getParent

public XMLStreamReader getParent()

Получить родителя этого экземпляра.

Возвращает:

родителя или null, если родитель не задан

next

public int next()
         throws XMLStreamException

Описание скопировано из интерфейса: XMLStreamReader

Определено в:

next в интерфейсе XMLStreamReader

Возвращает:

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

Исключение:

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

См. также:

XMLEvent

nextTag

public int nextTag()
            throws XMLStreamException

Описание скопировано из интерфейса: XMLStreamReader

Пропускает все пробелы (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;

Определено в:

nextTag в интерфейсе XMLStreamReader

Возвращает:

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

Исключение:

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

getElementText

public String getElementText()
                      throws XMLStreamException

Описание скопировано из интерфейса: XMLStreamReader

Считывает содержимое элемента только с текстом, исключение выбрасывается, если это не элемент только с текстом. Независимо от значения 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();

Определено в:

getElementText в интерфейсе XMLStreamReader

Исключение:

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

require

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

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

require в интерфейсе XMLStreamReader

Параметры:

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

namespaceURI - uri события, может быть null

localName - localName события, может быть null

Исключение:

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

hasNext

public boolean hasNext()
                throws XMLStreamException

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

hasNext в интерфейсе XMLStreamReader

Возвращает:

true, если есть больше событий, иначе false

Исключение:

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

close

public void close()
           throws XMLStreamException

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

close в интерфейсе XMLStreamReader

Исключение:

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

getNamespaceURI

public String getNamespaceURI(String prefix)

Описание скопировано из интерфейса: XMLStreamReader

Определено в:

getNamespaceURI в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

uri, привязанный к данному префиксу, или null, если он не привязан

getNamespaceContext

public NamespaceContext getNamespaceContext()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getNamespaceContext в интерфейсе XMLStreamReader

Возвращает:

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

isStartElement

public boolean isStartElement()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

isStartElement в интерфейсе XMLStreamReader

Возвращает:

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

isEndElement

public boolean isEndElement()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

isEndElement в интерфейсе XMLStreamReader

Возвращает:

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

isCharacters

public boolean isCharacters()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

isCharacters в интерфейсе XMLStreamReader

Возвращает:

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

isWhiteSpace

public boolean isWhiteSpace()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

isWhiteSpace в интерфейсе XMLStreamReader

Возвращает:

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

getAttributeValue

public String getAttributeValue(String namespaceUri,
                                String localName)

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getAttributeValue в интерфейсе XMLStreamReader

Параметры:

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

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

Возвращает:

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

getAttributeCount

public int getAttributeCount()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getAttributeCount в интерфейсе XMLStreamReader

Возвращает:

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

getAttributeName

public QName getAttributeName(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getAttributeName в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

QName атрибута

getAttributePrefix

public String getAttributePrefix(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getAttributePrefix в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

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

getAttributeNamespace

public String getAttributeNamespace(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getAttributeNamespace в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

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

getAttributeLocalName

public String getAttributeLocalName(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getAttributeLocalName в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

localName атрибута

getAttributeType

public String getAttributeType(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getAttributeType в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

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

getAttributeValue

public String getAttributeValue(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getAttributeValue в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

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

isAttributeSpecified

public boolean isAttributeSpecified(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

isAttributeSpecified в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

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

getNamespaceCount

public int getNamespaceCount()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getNamespaceCount в интерфейсе XMLStreamReader

Возвращает:

возвращает количество объявлений пространств имён для этого конкретного элемента

getNamespacePrefix

public String getNamespacePrefix(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getNamespacePrefix в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

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

getNamespaceURI

public String getNamespaceURI(int index)

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getNamespaceURI в интерфейсе XMLStreamReader

Параметры:

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

Возвращает:

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

getEventType

public int getEventType()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getEventType в интерфейсе XMLStreamReader

getText

public String getText()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getText в интерфейсе XMLStreamReader

Возвращает:

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

getTextCharacters

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

Описание скопировано из интерфейса: XMLStreamReader

Получает текст, связанный с событием 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".

Указано в:

getTextCharacters в интерфейсе XMLStreamReader

Параметры:

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

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

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

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

Возвращает:

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

Исключения:

XMLStreamException - если исходный XML-источник не является корректным

getTextCharacters

public char[] getTextCharacters()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getTextCharacters в интерфейсе XMLStreamReader

Возвращает:

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

getTextStart

public int getTextStart()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getTextStart в интерфейсе XMLStreamReader

getTextLength

public int getTextLength()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getTextLength в интерфейсе XMLStreamReader

getEncoding

public String getEncoding()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getEncoding в интерфейсе XMLStreamReader

Возвращает:

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

hasText

public boolean hasText()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

hasText в интерфейсе XMLStreamReader

getLocation

public Location getLocation()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getLocation в интерфейсе XMLStreamReader

getName

public QName getName()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getName в интерфейсе XMLStreamReader

Возвращает:

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

getLocalName

public String getLocalName()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getLocalName в интерфейсе XMLStreamReader

Возвращает:

localName

hasName

public boolean hasName()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

hasName в интерфейсе XMLStreamReader

getNamespaceURI

public String getNamespaceURI()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getNamespaceURI в интерфейсе XMLStreamReader

Возвращает:

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

getPrefix

public String getPrefix()

Описание скопировано из интерфейса: XMLStreamReader

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

Указано в:

getPrefix в интерфейсе XMLStreamReader

Возвращает:

префикс или null

getVersion

public String getVersion()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getVersion в интерфейсе XMLStreamReader

Возвращает:

версию XML или null

isStandalone

public boolean isStandalone()

Описание скопировано из интерфейса: XMLStreamReader

Получить объявленный автономный режим в декларации XML.

Определено в:

isStandalone в интерфейсе XMLStreamReader

Возвращает:

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

standaloneSet

public boolean standaloneSet()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

standaloneSet в интерфейсе XMLStreamReader

Возвращает:

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

getCharacterEncodingScheme

public String getCharacterEncodingScheme()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getCharacterEncodingScheme в интерфейсе XMLStreamReader

Возвращает:

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

getPITarget

public String getPITarget()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getPITarget в интерфейсе XMLStreamReader

Возвращает:

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

getPIData

public String getPIData()

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getPIData в интерфейсе XMLStreamReader

Возвращает:

данные или null

getProperty

public Object getProperty(String name)

Описание скопировано из интерфейса: XMLStreamReader

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

Определено в:

getProperty в интерфейсе XMLStreamReader

Параметры:

name - Название свойства, не может быть null

Возвращает:

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