XMLStreamReader (Платформа Java SE 7)

Все Суперинтерфейсы:: XMLStreamConstants

Все Известные Классы с реализацией:: StreamReaderDelegate

public interface XMLStreamReader
extends XMLStreamConstants

Интерфейс XMLStreamReader позволяет вперед, доступ только для чтения к XML. Это разрабатывается, чтобы быть самым низким уровнем и самым эффективным способом считать данные XML.

XMLStreamReader разрабатывается, чтобы выполнить итерации по XML, использующему затем () и hasNext (). К данным можно получить доступ, используя методы, такие как getEventType (), getNamespaceURI (), getLocalName () и getText ();

Следующее () метод заставляет читателя читать следующее событие синтаксического анализа. Следующее () метод возвращает целое число, которое идентифицирует тип события только чтение.

Тип события может быть определен, используя getEventType ().

Анализирующие события определяются как XML Объявление, DTD, запускают тег, символьные данные, пробел, конечный тэг, комментарий, или инструкцию обработки. С атрибутом или событием пространства имен можно встретиться на корневом уровне документа как результат работы запроса.

Для соответствия XML 1.0 процессор XML должен передать идентификаторы объявленных непроанализированных объектов, объявлений нотации и их связанных идентификаторов к приложению. Эта информация предоставляется через API свойства в этом интерфейсе. Следующие два свойства предоставляют доступ к этой информации: javax.xml.stream.notations и javax.xml.stream.entities. Когда текущее событие будет DTD, следующий вызов возвратит список Нотаций List l = (List) getProperty("javax.xml.stream.notations"); Следующий вызов возвратит список объявлений объекта: List l = (List) getProperty("javax.xml.stream.entities"); К этим свойствам можно только получить доступ во время события DTD и определяются, чтобы возвратить нуль, если информация не доступна.

Следующая таблица описывает, какие методы допустимы в какой состояние. Если метод вызовут в недопустимом состоянии, то метод бросит java.lang. IllegalStateException.

Допустимые методы для каждого состояния
Тип события	Допустимые Методы
Все государства	getProperty (), hasNext (), требуют (), близко (), getNamespaceURI (), isStartElement (), isEndElement (), isCharacters (), isWhiteSpace (), getNamespaceContext (), getEventType (), getLocation (), hasText (), hasName ()
START_ELEMENT	затем (), getName (), getLocalName (), hasName (), getPrefix (), getAttributeXXX (), isAttributeSpecified (), getNamespaceXXX (), getElementText (), nextTag ()
АТРИБУТ	затем (), nextTag () getAttributeXXX (), isAttributeSpecified (),
ПРОСТРАНСТВО ИМЕН	затем (), nextTag () getNamespaceXXX ()
END_ELEMENT	затем (), getName (), getLocalName (), hasName (), getPrefix (), getNamespaceXXX (), nextTag ()
СИМВОЛЫ	затем (), getTextXXX (), nextTag ()
CDATA	затем (), getTextXXX (), nextTag ()
КОММЕНТАРИЙ	затем (), getTextXXX (), nextTag ()
ПРОСТРАНСТВО	затем (), getTextXXX (), nextTag ()
START_DOCUMENT	затем (), getEncoding (), getVersion (), isStandalone (), standaloneSet (), getCharacterEncodingScheme (), nextTag ()
END_DOCUMENT	близко ()
PROCESSING_INSTRUCTION	затем (), getPITarget (), getPIData (), nextTag ()
ENTITY_REFERENCE	затем (), getLocalName (), getText (), nextTag ()
DTD	затем (), getText (), nextTag ()

С тех пор:: 1.6
См. Также:: XMLEvent, XMLInputFactory, XMLStreamWriter

Полевая Сводка
- Поля, наследованные от интерфейса javax.xml.stream. XMLStreamConstants
  ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Сводка метода

Методы
Модификатор и Тип	Метод и Описание
`void`	`close()` Освобождает любые ресурсы, связанные с этим Читателем.
`int`	`getAttributeCount()` Возвращает количество атрибутов на этом START_ELEMENT, этот метод только допустим на START_ELEMENT или АТРИБУТЕ.
`Строка`	`getAttributeLocalName(int index)` Возвращает localName атрибута по обеспеченному индексу
`QName`	`getAttributeName(int index)` Возвращает qname атрибута по обеспеченному индексу
`Строка`	`getAttributeNamespace(int index)` Возвращает пространство имен атрибута по обеспеченному индексу
`Строка`	`getAttributePrefix(int index)` Возвращает префикс этого атрибута по обеспеченному индексу
`Строка`	`getAttributeType(int index)` Возвращает тип XML атрибута по обеспеченному индексу
`Строка`	`getAttributeValue(int index)` Возвращает значение атрибута по индексу
`Строка`	`getAttributeValue(String namespaceURI, String localName)` Возвращает нормализованное значение атрибута атрибута с пространством имен и localName, Если namespaceURI является нулем, пространство имен не проверяется на равенство
`Строка`	`getCharacterEncodingScheme()` Возвращает кодировку символов, объявленную на xml объявлении нуль Возвратов, если ни один не был объявлен
`Строка`	`getElementText()` Читает контент элемента только для текста, исключение выдается, если это не элемент только для текста.
`Строка`	`getEncoding()` Возвратите входное кодирование если известный или нуль если неизвестный.
`int`	`getEventType()` Возвращает целочисленный код, который указывает на тип события, на которое указывает курсор.
`Строка`	`getLocalName()` Возвращает (локальное) имя текущего события.
`Расположение`	`getLocation()` Возвратите текущее расположение процессора.
`QName`	`getName()` Возвращает QName для текущего события START_ELEMENT ИЛИ END_ELEMENT
`NamespaceContext`	`getNamespaceContext()` Возвращает контекст пространства имен только для чтения для текущей позиции.
`int`	`getNamespaceCount()` Возвращает количество пространств имен, объявленных на этом START_ELEMENT или END_ELEMENT, этот метод только допустим на START_ELEMENT, END_ELEMENT или ПРОСТРАНСТВЕ ИМЕН.
`Строка`	`getNamespacePrefix(int index)` Возвращает префикс для пространства имен, объявленного по индексу.
`Строка`	`getNamespaceURI()` Если текущее событие является START_ELEMENT или END_ELEMENT, этот метод возвращает URI префикса или пространства имен по умолчанию.
`Строка`	`getNamespaceURI(int index)` Возвращает туров для пространства имен, объявленного по индексу.
`Строка`	`getNamespaceURI(String prefix)` Возвратите туров для данного префикса.
`Строка`	`getPIData()` Получите раздел данных инструкции обработки
`Строка`	`getPITarget()` Получите цель инструкции обработки
`Строка`	`getPrefix()` Возвращает префикс текущего события или нуля, если у события нет префикса
`Объект`	`getProperty(String name)` Получите значение функции/свойства от базовой реализации
`Строка`	`getText()` Возвращает текущую стоимость события синтаксического анализа как строка, это возвращает строковое значение события CHARACTERS, возвращает значение КОММЕНТАРИЯ, заменяющее значение для ENTITY_REFERENCE, строковое значение раздела CDATA, строковое значение для события SPACE, или Строковое значение внутреннего подмножества DTD.
`char[]`	`getTextCharacters()` Возвращает массив, который содержит символы от этого события.
`int`	`getTextCharacters(int sourceStart, char[] target, int targetStart, int length)` Получает текст, связанный с СИМВОЛЫ, событие SPACE ИЛИ CDATA.
`int`	`getTextLength()` Возвращает длину последовательности символов для этого текстового события в пределах текстового массива символа.
`int`	`getTextStart()` Возвращает смещение в текстовый массив символа, где первый символ (этого текстового события) сохранен.
`Строка`	`getVersion()` Объявите xml версию на xml объявлении нуль Возвратов, если ни один не был объявлен
`boolean`	`hasName()` возвращает true, если у текущего события есть имя (START_ELEMENT, или END_ELEMENT) возвращает false иначе
`boolean`	`hasNext()` Возвращает true, если там более анализируют события и ложь, если нет больше событий.
`boolean`	`hasText()` Возвратите true, если у текущего события есть текст, ложь иначе, У следующих событий есть текст: СИМВОЛЫ, DTD, ENTITY_REFERENCE, КОММЕНТАРИЙ, ПРОСТРАНСТВО
`boolean`	`isAttributeSpecified(int index)` Возвращает булевскую переменную, которая указывает, создавался ли этот атрибут по умолчанию
`boolean`	`isCharacters()` Возвращает true, если курсор указывает на символьное событие данных
`boolean`	`isEndElement()` Возвращает true, если курсор указывает на конечный тэг (иначе ложь)
`boolean`	`isStandalone()` Получите автономное объявление от xml объявления
`boolean`	`isStartElement()` Возвращает true, если курсор указывает на тег запуска (иначе ложь)
`boolean`	`isWhiteSpace()` Возвращает true, если курсор указывает на символьное событие данных, которое состоит из всего пробела
`int`	`next()` Получите следующее событие парсинга - процессор может возвратить все непрерывные символьные данные в единственном блоке, или это может разделить это на несколько блоков.
`int`	`nextTag()` Достигаются пропуски любой пробел (isWhiteSpace () возвращает true), КОММЕНТАРИЙ, или PROCESSING_INSTRUCTION, до START_ELEMENT или END_ELEMENT.
`void`	`require(int type, String namespaceURI, String localName)` Тест, если текущее событие имеет данный тип и если пространство имен и имя соответствуют текущее пространство имен и имя текущего события.
`boolean`	`standaloneSet()` Проверки если автономный были установлены в документе

- Деталь метода
  - getProperty
```
Object getProperty(String name)
                   throws IllegalArgumentException
```
    Получите значение функции/свойства от базовой реализации
    
    Параметры:
    name - Имя свойства, возможно, не нуль
    
    Возвраты:
    Значение свойства
    
    Броски:
    
    IllegalArgumentException - если имя является нулем
  - затем
```
int next()
         throws XMLStreamException
```
    Получите следующее событие парсинга - процессор может возвратить все непрерывные символьные данные в единственном блоке, или это может разделить это на несколько блоков. Если свойство javax.xml.stream.isCoalescing устанавливается в истинный контент элемента, должен быть объединен, и только одно событие CHARACTERS должно быть возвращено для непрерывного контента элемента или Разделов CDATA. Ссылками на сущность по умолчанию должен быть расширен и сообщен прозрачно приложению. Исключение будет выдано, если ссылка на сущность не может быть расширена. Если контент элемента будет пуст (то есть контент""), тогда, то ни о каком событии CHARACTERS не сообщат.
    Учитывая следующий XML:
    <foo> <! - описание-> текст контента <! [CDATA [<приветствующий> Привет </приветствующий>]]> другой контент </foo>
    Поведение вызова затем () будучи на foo будет:
    1-комментарий (КОММЕНТАРИЙ)
    2-тогда символы разделяют (СИМВОЛЫ)
    3-тогда раздел CDATA (другой СИМВОЛЫ)
    4-тогда следующий раздел символов (другой СИМВОЛЫ)
    5-тогда END_ELEMENT
    
    ОТМЕТЬТЕ: о пустом элементе (такой как <тег/>) сообщат с двумя отдельными событиями: START_ELEMENT, END_ELEMENT - Это сохраняет эквивалентность парсинга пустого элемента, чтобы <тегировать> </тег>. Этот метод бросит IllegalStateException, если его вызовут, после hasNext () возвращает false.
    
    Возвраты:
    целочисленный код, соответствующий текущему событию синтаксического анализа
    
    Броски:
    
    NoSuchElementException - если это вызывают, когда hasNext () возвращает false
    
    XMLStreamException - если есть ошибка, обрабатывая базовый источник XML
    См. Также:
    XMLEvent
  - потребовать
```
void require(int type,
           String namespaceURI,
           String localName)
             throws XMLStreamException
```
    Тест, если текущее событие имеет данный тип и если пространство имен и имя соответствуют текущее пространство имен и имя текущего события. Если namespaceURI является нулем, это не проверяется на равенство, если localName является нулем, это не проверяется на равенство.
    
    Параметры:
    type - тип события
    namespaceURI - туры события, может быть нуль
    localName - localName события, может быть нуль
    
    Броски:
    
    XMLStreamException - если необходимые значения не являются соответствующими.
  - getElementText
```
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();
 
```
    Броски:
    
    XMLStreamException - если текущее событие не является START_ELEMENT или если с не текстовым элементом встречаются
  - nextTag
```
int nextTag()
            throws XMLStreamException
```
    Достигаются пропуски любой пробел (isWhiteSpace () возвращает true), КОММЕНТАРИЙ, или PROCESSING_INSTRUCTION, до START_ELEMENT или END_ELEMENT. Если кроме пробельных символов, КОММЕНТАРИЯ, PROCESSING_INSTRUCTION, START_ELEMENT, с END_ELEMENT встречаются, исключение выдается. Этот метод должен использоваться, обрабатывая контент только для элемента seperated пробелом.
    Предварительное условие: ни один
    Постусловие: текущее событие является 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;
 
```
    Возвраты:
    тип события чтения элемента (START_ELEMENT или END_ELEMENT)
    
    Броски:
    
    XMLStreamException - если текущее событие не является пробелом, PROCESSING_INSTRUCTION, START_ELEMENT или END_ELEMENT
    
    NoSuchElementException - если это вызывают, когда hasNext () возвращает false
  - hasNext
```
boolean hasNext()
                throws XMLStreamException
```
    Возвращает true, если там более анализируют события и ложь, если нет больше событий. Этот метод возвратит false, если текущее состояние XMLStreamReader будет END_DOCUMENT
    
    Возвраты:
    истина, если есть больше событий, ложь иначе
    
    Броски:
    
    XMLStreamException - если есть фатальная ошибка, обнаруживающая следующее состояние
  - близко
```
void close()
           throws XMLStreamException
```
    Освобождает любые ресурсы, связанные с этим Читателем. Этот метод не закрывает базовый входной источник.
    
    Броски:
    
    XMLStreamException - если есть ошибки, освобождая связанные ресурсы
  - getNamespaceURI
```
String getNamespaceURI(String prefix)
```
    Возвратите туров для данного префикса. Возвращенные туры зависят от текущего состояния процессора.
    NOTE:The 'xml' префикс связывается как определено в Пространствах имен в спецификации XML к "http://www.w3.org/XML/1998/namespace".
    ОТМЕТЬТЕ: префикс 'xmlns' должен быть разрешен к следующему пространству имен http://www.w3.org/2000/xmlns/
    
    Параметры:
    prefix - Префикс к поиску, возможно, не нуль
    
    Возвраты:
    туры, связанные с данным префиксом или нулем, если это не связывается
    
    Броски:
    
    IllegalArgumentException - если префикс является нулем
  - isStartElement
```
boolean isStartElement()
```
    Возвращает true, если курсор указывает на тег запуска (иначе ложь)
    
    Возвраты:
    истина, если курсор указывает на тег запуска, ложь иначе
  - isEndElement
```
boolean isEndElement()
```
    Возвращает true, если курсор указывает на конечный тэг (иначе ложь)
    
    Возвраты:
    истина, если курсор указывает на конечный тэг, ложь иначе
  - isCharacters
```
boolean isCharacters()
```
    Возвращает true, если курсор указывает на символьное событие данных
    
    Возвраты:
    истина, если курсор указывает на символьные данные, ложь иначе
  - isWhiteSpace
```
boolean isWhiteSpace()
```
    Возвращает true, если курсор указывает на символьное событие данных, которое состоит из всего пробела
    
    Возвраты:
    истина, если курсор указывает на весь пробел, ложь иначе
  - getAttributeValue
```
String getAttributeValue(String namespaceURI,
                       String localName)
```
    Возвращает нормализованное значение атрибута атрибута с пространством имен и localName, Если namespaceURI является нулем, пространство имен не проверяется на равенство
    
    Параметры:
    namespaceURI - пространство имен атрибута
    localName - локальное имя атрибута, не может быть нуль
    
    Возвраты:
    возвращает значение атрибута, нуль возвратов если не найденный
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getAttributeCount
```
int getAttributeCount()
```
    Возвращает количество атрибутов на этом START_ELEMENT, этот метод только допустим на START_ELEMENT или АТРИБУТЕ. Это количество исключает определения пространства имен. Индексы атрибута основаны на нуле.
    
    Возвраты:
    возвращает число атрибутов
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getAttributeName
```
QName getAttributeName(int index)
```
    Возвращает qname атрибута по обеспеченному индексу
    
    Параметры:
    index - позиция атрибута
    
    Возвраты:
    QName атрибута
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getAttributeNamespace
```
String getAttributeNamespace(int index)
```
    Возвращает пространство имен атрибута по обеспеченному индексу
    
    Параметры:
    index - позиция атрибута
    
    Возвраты:
    URI пространства имен (может быть нуль),
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getAttributeLocalName
```
String getAttributeLocalName(int index)
```
    Возвращает localName атрибута по обеспеченному индексу
    
    Параметры:
    index - позиция атрибута
    
    Возвраты:
    localName атрибута
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getAttributePrefix
```
String getAttributePrefix(int index)
```
    Возвращает префикс этого атрибута по обеспеченному индексу
    
    Параметры:
    index - позиция атрибута
    
    Возвраты:
    префикс атрибута
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getAttributeType
```
String getAttributeType(int index)
```
    Возвращает тип XML атрибута по обеспеченному индексу
    
    Параметры:
    index - позиция атрибута
    
    Возвраты:
    тип XML атрибута
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getAttributeValue
```
String getAttributeValue(int index)
```
    Возвращает значение атрибута по индексу
    
    Параметры:
    index - позиция атрибута
    
    Возвраты:
    значение атрибута
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - isAttributeSpecified
```
boolean isAttributeSpecified(int index)
```
    Возвращает булевскую переменную, которая указывает, создавался ли этот атрибут по умолчанию
    
    Параметры:
    index - позиция атрибута
    
    Возвраты:
    истина, если это - атрибут по умолчанию
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT или АТРИБУТ
  - getNamespaceCount
```
int getNamespaceCount()
```
    Возвращает количество пространств имен, объявленных на этом START_ELEMENT или END_ELEMENT, этот метод только допустим на START_ELEMENT, END_ELEMENT или ПРОСТРАНСТВЕ ИМЕН. На END_ELEMENT количество имеет пространства имен, которые собираются выйти из контекста. Это - эквивалент информации, сообщенной обратным вызовом SAX для события элемента конца.
    
    Возвраты:
    возвращает число объявлений пространства имен на этом определенном элементе
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT, END_ELEMENT или ПРОСТРАНСТВО ИМЕН
  - getNamespacePrefix
```
String getNamespacePrefix(int index)
```
    Возвращает префикс для пространства имен, объявленного по индексу. Нуль возвратов, если это - объявление пространства имен по умолчанию
    
    Параметры:
    index - позиция объявления пространства имен
    
    Возвраты:
    возвращает префикс пространства имен
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT, END_ELEMENT или ПРОСТРАНСТВО ИМЕН
  - getNamespaceURI
```
String getNamespaceURI(int index)
```
    Возвращает туров для пространства имен, объявленного по индексу.
    
    Параметры:
    index - позиция объявления пространства имен
    
    Возвраты:
    возвращает туров пространства имен
    
    Броски:
    
    IllegalStateException - если это не START_ELEMENT, END_ELEMENT или ПРОСТРАНСТВО ИМЕН
  - getNamespaceContext
```
NamespaceContext getNamespaceContext()
```
    Возвращает контекст пространства имен только для чтения для текущей позиции. Контекст является переходным процессом и только допустимый, пока звонок затем () не изменяет состояние читателя.
    
    Возвраты:
    возвратите контекст пространства имен
  - getEventType
```
int getEventType()
```
    Возвращает целочисленный код, который указывает на тип события, на которое указывает курсор.
  - getText
```
String getText()
```
    Возвращает текущую стоимость события синтаксического анализа как строка, это возвращает строковое значение события CHARACTERS, возвращает значение КОММЕНТАРИЯ, заменяющее значение для ENTITY_REFERENCE, строковое значение раздела CDATA, строковое значение для события SPACE, или Строковое значение внутреннего подмножества DTD. Если ENTITY_REFERENCE был разрешен, о любых символьных данных сообщат как события CHARACTERS.
    
    Возвраты:
    текущий текст или нуль
    
    Броски:
    
    IllegalStateException - если это состояние не является допустимым текстовым состоянием.
  - getTextCharacters
```
char[] getTextCharacters()
```
    Возвращает массив, который содержит символы от этого события. Этот массив должен быть обработан как только для чтения и переходный. То есть массив будет содержать текстовые символы до шагов XMLStreamReader к следующему событию. Попытки содержать на символьный массив кроме того время или изменить содержание массива являются нарушениями договора для этого интерфейса.
    
    Возвраты:
    текущий текст или пустой массив
    
    Броски:
    
    IllegalStateException - если это состояние не является допустимым текстовым состоянием.
  - getTextCharacters
```
int getTextCharacters(int sourceStart,
                    char[] target,
                    int targetStart,
                    int length)
                      throws XMLStreamException
```
    Получает текст, связанный с СИМВОЛЫ, событие SPACE ИЛИ CDATA. Текст, начинающий "sourceStart", копируется в "цель", запускающуюся в "targetStart". До "длины" копируются символы. Число символов, фактически скопированных, возвращается. "sourceStart" параметр должен быть больше или равным 0 и меньше чем или равным числу символов, связанных с событием. Обычно, каждый запрашивает текст, запускающийся в "sourceStart" 0. Если число символов, фактически скопированных, является меньше чем "длина", то нет больше текста. Иначе, последующие вызовы должны быть выполнены, пока весь текст не был получен. Например: 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 may be thrown if there are any XML errors in the underlying source. The "targetStart" argument must be greater than or equal to 0 and less than the length of "target", Length must be greater than 0 and "targetStart + length" must be less than or equal to length of "target".
    
    Parameters:
    sourceStart - the index of the first character in the source array to copy
    target - the destination array
    targetStart - the start offset in the target array
    length - the number of characters to copy
    
    Returns:
    the number of characters actually copied
    
    Throws:
    
    XMLStreamException - if the underlying XML source is not well-formed
    
    IndexOutOfBoundsException - if targetStart < 0 or > than the length of target
    
    IndexOutOfBoundsException - if length < 0 or targetStart + length > length of target
    
    UnsupportedOperationException - if this method is not supported
    
    NullPointerException - is if target is null
  - getTextStart
```
int getTextStart()
```
    Returns the offset into the text character array where the first character (of this text event) is stored.
    
    Throws:
    
    IllegalStateException - if this state is not a valid text state.
  - getTextLength
```
int getTextLength()
```
    Returns the length of the sequence of characters for this Text event within the text character array.
    
    Throws:
    
    IllegalStateException - if this state is not a valid text state.
  - getEncoding
```
String getEncoding()
```
    Return input encoding if known or null if unknown.
    
    Returns:
    the encoding of this instance or null
  - hasText
```
boolean hasText()
```
    Return true if the current event has text, false otherwise The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE
  - getLocation
```
Location getLocation()
```
    Return the current location of the processor. If the Location is unknown the processor should return an implementation of Location that returns -1 for the location and null for the publicId and systemId. The location information is only valid until next() is called.
  - getName
```
QName getName()
```
    Returns a QName for the current START_ELEMENT or END_ELEMENT event
    
    Returns:
    the QName for the current START_ELEMENT or END_ELEMENT event
    
    Throws:
    
    IllegalStateException - if this is not a START_ELEMENT or END_ELEMENT
  - getLocalName
```
String getLocalName()
```
    Returns the (local) name of the current event. For START_ELEMENT or END_ELEMENT returns the (local) name of the current element. For ENTITY_REFERENCE it returns entity name. The current event must be START_ELEMENT or END_ELEMENT, or ENTITY_REFERENCE
    
    Returns:
    the localName
    
    Throws:
    
    IllegalStateException - if this not a START_ELEMENT, END_ELEMENT or ENTITY_REFERENCE
  - hasName
```
boolean hasName()
```
    returns true if the current event has a name (is a START_ELEMENT or END_ELEMENT) returns false otherwise
  - getNamespaceURI
```
String getNamespaceURI()
```
    If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace. Returns null if the event does not have a prefix.
    
    Returns:
    the URI bound to this elements prefix, the default namespace, or null
  - getPrefix
```
String getPrefix()
```
    Returns the prefix of the current event or null if the event does not have a prefix
    
    Returns:
    the prefix or null
  - getVersion
```
String getVersion()
```
    Get the xml version declared on the xml declaration Returns null if none was declared
    
    Returns:
    the XML version or null
  - isStandalone
```
boolean isStandalone()
```
    Get the standalone declaration from the xml declaration
    
    Returns:
    true if this is standalone, or false otherwise
  - standaloneSet
```
boolean standaloneSet()
```
    Checks if standalone was set in the document
    
    Returns:
    true if standalone was set in the document, or false otherwise
  - getCharacterEncodingScheme
```
String getCharacterEncodingScheme()
```
    Returns the character encoding declared on the xml declaration Returns null if none was declared
    
    Returns:
    the encoding declared in the document or null
  - getPITarget
```
String getPITarget()
```
    Get the target of a processing instruction
    
    Returns:
    the target or null
  - getPIData
```
String getPIData()
```
    Get the data section of a processing instruction
    
    Returns:
    the data or null

Представьте ошибку или функцию
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Интерфейсный XMLStreamReader

Полевая Сводка

Поля, наследованные от интерфейса javax.xml.stream. XMLStreamConstants

Сводка метода

Деталь метода

getProperty

затем

потребовать

getElementText

nextTag

hasNext

близко

getNamespaceURI

isStartElement

isEndElement

isCharacters

isWhiteSpace

getAttributeValue

getAttributeCount

getAttributeName

getAttributeNamespace

getAttributeLocalName

getAttributePrefix

getAttributeType

getAttributeValue

isAttributeSpecified

getNamespaceCount

getNamespacePrefix

getNamespaceURI

getNamespaceContext

getEventType

getText

getTextCharacters

getTextCharacters

getTextStart

getTextLength

getEncoding

hasText

getLocation

getName

getLocalName

hasName

getNamespaceURI

getPrefix

getVersion

isStandalone

standaloneSet

getCharacterEncodingScheme

getPITarget

getPIData