Spec-Zone.ru › OpenJDK 27

Класс StreamReaderDelegate

java.lang.Object
javax.xml.stream.util.StreamReaderDelegate
Все реализуемые интерфейсы:
XMLStreamConstants, XMLStreamReader
public class StreamReaderDelegate extends Object implements XMLStreamReader
Это базовый класс для создания фильтра XMLStreamReader. Этот класс предназначен для размещения между XMLStreamReader и XMLStreamReader приложения. По умолчанию каждый метод ничего не делает, кроме вызова соответствующего метода родительского интерфейса.
Начиная с:
1.6
См. также:
  • XMLStreamReader
  • EventReaderDelegate

Краткое описание полей

Поля, объявленные в интерфейсе XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
Модификатор и тип Поле Описание
static final int ATTRIBUTE
Указывает, что событие является атрибутом
static final int CDATA
Указывает, что событие является секцией CDATA
static final int CHARACTERS
Указывает, что событие содержит символы
static final int COMMENT
Указывает, что событие является комментарием
static final int DTD
Указывает, что событие является DTD
static final int END_DOCUMENT
Указывает, что событие является концом документа
static final int END_ELEMENT
Указывает, что событие является концом элемента
static final int ENTITY_DECLARATION
Указывает на объявление сущности
static final int ENTITY_REFERENCE
Указывает, что событие является ссылкой на сущность
static final int NAMESPACE
Указывает, что событие является объявлением пространства имён
static final int NOTATION_DECLARATION
Указывает на нотацию
static final int PROCESSING_INSTRUCTION
Указывает, что событие является инструкцией обработки
static final int SPACE
Символы являются пробельными (см. [XML], 2.10 «Обработка пробельных символов»).
static final int START_DOCUMENT
Указывает, что событие является началом документа
static final int START_ELEMENT
Указывает, что событие является началом элемента

Краткое описание конструкторов

Конструктор Описание
StreamReaderDelegate()
Создаёт пустой фильтр без родительского объекта.
StreamReaderDelegate(XMLStreamReader reader)
Создаёт фильтр с указанным родительским объектом.

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

Модификатор и тип Метод Описание
void close()
Освобождает все ресурсы, связанные с этим Reader.
int getAttributeCount()
Возвращает количество атрибутов этого START_ELEMENT; этот метод допустимо вызывать только для START_ELEMENT или ATTRIBUTE.
String getAttributeLocalName(int index)
Возвращает localName атрибута с указанным индексом
QName getAttributeName(int index)
Возвращает qname атрибута с указанным индексом
String getAttributeNamespace(int index)
Возвращает пространство имён атрибута с указанным индексом
String getAttributePrefix(int index)
Возвращает префикс атрибута с указанным индексом
String getAttributeType(int index)
Возвращает тип XML атрибута с указанным индексом
String getAttributeValue(int index)
Возвращает значение атрибута с указанным индексом
String getAttributeValue(String namespaceUri, String localName)
Возвращает нормализованное значение атрибута, заданного пространством имён и localName. Если namespaceURI равен null, проверка пространства имён на равенство не выполняется
String getCharacterEncodingScheme()
Возвращает кодировку символов, объявленную в объявлении XML. Если кодировка не объявлена, возвращает null
String getElementText()
Считывает содержимое элемента, содержащего только текст; если элемент не является текстовым, генерируется исключение.
String getEncoding()
Возвращает кодировку входных данных, если она известна, или null, если неизвестна.
int getEventType()
Возвращает целочисленный код, указывающий тип события, на которое указывает курсор.
String getLocalName()
Возвращает (локальное) имя текущего события.
Location getLocation()
Возвращает текущее местоположение процессора.
QName getName()
Возвращает QName для текущего события START_ELEMENT или END_ELEMENT
NamespaceContext getNamespaceContext()
Возвращает доступный только для чтения контекст пространства имён для текущей позиции.
int getNamespaceCount()
Возвращает количество пространств имён, объявленных в этом START_ELEMENT или END_ELEMENT; этот метод допустимо вызывать только для START_ELEMENT, END_ELEMENT или NAMESPACE.
String getNamespacePrefix(int index)
Возвращает префикс пространства имён, объявленного по указанному индексу.
String getNamespaceURI()
Если текущее событие — START_ELEMENT или END_ELEMENT, этот метод возвращает URI префикса или пространства имён по умолчанию.
String getNamespaceURI(int index)
Возвращает URI пространства имён, объявленного по указанному индексу.
String getNamespaceURI(String prefix)
Возвращает URI для указанного префикса.
XMLStreamReader getParent()
Возвращает родительский объект этого экземпляра.
String getPIData()
Возвращает секцию данных инструкции обработки
String getPITarget()
Возвращает цель инструкции обработки
String getPrefix()
Возвращает префикс текущего события или null, если у события нет префикса
Object getProperty(String name)
Получает значение функции/свойства из базовой реализации
String getText()
Возвращает текущее значение события разбора в виде строки: строковое значение события CHARACTERS, значение COMMENT, замещающее значение ENTITY_REFERENCE, строковое значение секции CDATA, строковое значение события SPACE или строковое значение внутреннего подмножества DTD.
char[] getTextCharacters()
Возвращает массив, содержащий символы этого события.
int getTextCharacters(int sourceStart, char[] target, int targetStart, int length)
Получает текст, связанный с событием CHARACTERS, SPACE или CDATA.
int getTextLength()
Возвращает длину последовательности символов этого текстового события в массиве текстовых символов.
int getTextStart()
Возвращает смещение в массиве текстовых символов, по которому хранится первый символ (этого текстового события).
String getVersion()
Возвращает версию XML, объявленную в объявлении XML. Если версия не объявлена, возвращает null
boolean hasName()
Возвращает логическое значение, указывающее, имеет ли текущее событие имя (является ли оно START_ELEMENT или END_ELEMENT).
boolean hasNext()
Возвращает true, если остались события разбора, и false, если событий больше нет.
boolean hasText()
Возвращает логическое значение, указывающее, содержит ли текущее событие текст.
boolean isAttributeSpecified(int index)
Возвращает логическое значение, указывающее, был ли этот атрибут создан по умолчанию
boolean isCharacters()
Возвращает true, если курсор указывает на событие символьных данных
boolean isEndElement()
Возвращает true, если курсор указывает на закрывающий тег (в противном случае — false)
boolean isStandalone()
Получает объявление standalone из объявления XML
boolean isStartElement()
Возвращает true, если курсор указывает на открывающий тег (в противном случае — false)
boolean isWhiteSpace()
Возвращает true, если курсор указывает на событие символьных данных, состоящее только из пробельных символов
int next()
Получает следующее событие разбора. Процессор может вернуть все смежные символьные данные одним фрагментом или разделить их на несколько фрагментов.
int nextTag()
Пропускает все пробельные символы (isWhiteSpace() возвращает true), COMMENT или PROCESSING_INSTRUCTION до тех пор, пока не встретится START_ELEMENT или END_ELEMENT.
void require(int type, String namespaceURI, String localName)
Проверяет, имеет ли текущее событие указанный тип и совпадают ли пространство имён и имя с пространством имён и именем текущего события.
void setParent(XMLStreamReader reader)
Задаёт родительский объект для этого экземпляра.
boolean standaloneSet()
Проверяет, было ли в документе задано значение standalone

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создаёт и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли этот объект какому-либо другому объекту.
protected void finalize()
Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии.
Финализация устарела и подлежит удалению в одном из следующих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
String toString()
Возвращает строковое представление объекта.
final void wait()
Приостанавливает текущий поток до его пробуждения, обычно посредством уведомления или прерывания.
final void wait(long timeoutMillis)
Приостанавливает текущий поток до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного периода реального времени.
final void wait(long timeoutMillis, int nanos)
Приостанавливает текущий поток до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного периода реального времени.

Подробное описание конструкторов

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
Получает следующее событие разбора — обработчик может возвращать все смежные символьные данные одним фрагментом или разделять их на несколько фрагментов. Если свойство javax.xml.stream.isCoalescing имеет значение true, содержимое элементов должно объединяться, и для смежного содержимого элементов или разделов CDATA должно возвращаться только одно событие CHARACTERS. По умолчанию ссылки на сущности должны раскрываться и прозрачно передаваться приложению. Если ссылку на сущность невозможно раскрыть, будет выброшено исключение. Если содержимое элемента пустое (то есть content равно ""), событие 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>.

Определено в:
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
Освобождает все ресурсы, связанные с этим Reader. Этот метод не закрывает базовый источник ввода.
Определено в:
close в интерфейсе XMLStreamReader
Выбрасывает:
XMLStreamException — если при освобождении связанных ресурсов возникают ошибки

getNamespaceURI

public String getNamespaceURI(String prefix)
Описание скопировано из интерфейса: XMLStreamReader
Возвращает URI для указанного префикса. Возвращаемый URI зависит от текущего состояния обработчика.

ПРИМЕЧАНИЕ: префикс 'xml' связан с пространством имен "http://www.w3.org/XML/1998/namespace" согласно спецификации Пространства имен в XML.

ПРИМЕЧАНИЕ: префикс 'xmlns' должен разрешаться в следующее пространство имен: http://www.w3.org/2000/xmlns/

Определено в:
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 для события конечного элемента.
Определено в:
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
Возвращает целочисленный код, указывающий тип события, на которое указывает курсор. Начальный тип события — XMLStreamConstants.START_DOCUMENT.
Определено в:
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;
}
 
Если в базовом источнике обнаружены ошибки XML, может быть выброшено XMLStreamException. Аргумент "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
Возвращает логическое значение, указывающее, содержит ли текущее событие текст. Текст содержат следующие события: CHARACTERS, DTD, ENTITY_REFERENCE, COMMENT, SPACE.
Определено в:
hasText в интерфейсе XMLStreamReader
Возвращает:
true, если событие содержит текст, иначе false

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
Возвращает логическое значение, указывающее, имеет ли текущее событие имя (является ли оно START_ELEMENT или END_ELEMENT).
Определено в:
hasName в интерфейсе XMLStreamReader
Возвращает:
true, если событие имеет имя, иначе false

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
Получить объявление standalone из объявления xml
Указано в:
isStandalone в интерфейсе XMLStreamReader
Возвращает:
true, если это standalone, иначе false

standaloneSet

public boolean standaloneSet()
Описание скопировано из интерфейса: XMLStreamReader
Проверяет, было ли значение standalone задано в документе
Указано в:
standaloneSet в интерфейсе XMLStreamReader
Возвращает:
true, если значение standalone было задано в документе, иначе 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
Возвращает:
Значение свойства

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2026, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API