compact2, compact3

javax.xml.stream.util

Class StreamReaderDelegate

java.lang.Object

javax.xml.stream.util.StreamReaderDelegate

All Implemented Interfaces:

XMLStreamConstants ， XMLStreamReader

public class StreamReaderDelegate
extends Object
implements XMLStreamReader

这是派生XMLStreamReader过滤器的基础类此类设计为位于XMLStreamReader和应用程序的XMLStreamReader之间。 默认情况下，每个方法都不会调用父接口上的相应方法。

从以下版本开始：

1.6

Version:

1.0

另请参见：

XMLStreamReader ， EventReaderDelegate

Field Summary

Fields inherited from interface 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

构造方法摘要

构造方法

Constructor and Description
StreamReaderDelegate() 构造一个没有父进程的空过滤器。
StreamReaderDelegate(XMLStreamReader reader) 使用指定的父构造一个过滤器。

方法摘要

Modifier and Type	Method and Description
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为空，则不会检查命名空间是否相等
String	getCharacterEncodingScheme() 返回在xml声明中声明的字符编码如果没有声明，则返回null
String	getElementText() 读取纯文本元素的内容，如果这不是纯文本元素，则抛出异常。
String	getEncoding() 如果已知返回输入编码，如果未知则返回null。
int	getEventType() 返回指示光标指向的事件类型的整数代码。
String	getLocalName() 返回当前事件的（本地）名称。
Location	getLocation() 返回处理器的当前位置。
QName	getName() 返回当前START_ELEMENT或END_ELEMENT活动的QName
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的内部子集的String值。
char[]	getTextCharacters() 返回一个包含此事件中的字符的数组。
int	getTextCharacters(int sourceStart, char[] target, int targetStart, int length) 获取与CHARACTERS，SPACE或CDATA事件关联的文本。
int	getTextLength() 返回文本字符数组中此Text事件的字符序列长度。
int	getTextStart() 返回文本字符数组中存在第一个字符（该文本事件）的偏移量。
String	getVersion() 获取在xml声明中声明的xml版本如果没有声明，则返回null
boolean	hasName() 如果当前事件有一个名称（是START_ELEMENT或END_ELEMENT）返回false则返回true
boolean	hasNext() 如果有更多的解析事件，返回true，如果没有更多的事件，返回false。
boolean	hasText() 如果当前事件有文本，则返回true，否则返回false以下事件具有文本：CHARACTERS，DTD，ENTITY_REFERENCE，COMMENT，SPACE
boolean	isAttributeSpecified(int index) 返回一个布尔值，表示此属性是否默认创建
boolean	isCharacters() 如果光标指向字符数据事件，则返回true
boolean	isEndElement() 如果光标指向结束标记（否则为false），则返回true
boolean	isStandalone() 从xml声明获取独立声明
boolean	isStartElement() 如果光标指向起始标记（否则为false），则返回true
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() 检查文档中是否设置了独立的

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

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事件。 默认情况下，实体引用必须对应用程序进行扩展和报告。 如果无法扩展实体引用，将抛出异常。 如果元素内容为空（即内容为“”），则不会报告CHARACTERS事件。

给出以下XML：
<foo> <！ - description - >内容文本<！[CDATA [<greeting> Hello </ greeting>]]>其他内容</ foo>
在foo上调用next（）的行为是：
1-评论（评论）
2-然后字符部分（CHARACTERS）
3然后CDATA部分（另一个字符）
4 - 然后下一个字符部分（另一个CHARACTERS）
5，然后END_ELEMENT

注意：空元素（例如<tag />）将报告两个单独的事件：START_ELEMENT，END_ELEMENT - 这将空元素的解析等同于<tag> </ tag>。 如果在hasNext（）返回false之后调用该方法，则会抛出IllegalStateException异常。

Specified by:

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; 

Specified by:

nextTag在接口 XMLStreamReader

结果

读取的元素的事件类型（START_ELEMENT或END_ELEMENT）

异常

XMLStreamException - 如果当前事件不是空格，PROCESSING_INSTRUCTION，START_ELEMENT或END_ELEMENT

getElementText

public String getElementText()
                      throws XMLStreamException

说明从界面复制： XMLStreamReader

读取纯文本元素的内容，如果这不是纯文本元素，则抛出异常。 无论javax.xml.stream.is的结果如何，这个方法总是返回合并的内容。
前提条件：当前事件为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(); 

Specified by:

getElementText在接口 XMLStreamReader

异常

XMLStreamException - 如果当前事件不是START_ELEMENT或遇到非文本元素

require

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

说明从界面复制： XMLStreamReader

测试当前事件是否为给定类型，如果命名空间和名称与当前命名空间和当前事件的名称相匹配。 如果namespaceURI为空，则不检查是否相等，如果localName为空，则不检查其是否相等。

Specified by:

require在界面 XMLStreamReader

参数

type - 事件类型

namespaceURI - 事件的uri可能为null

localName - 该事件的localName可能为null

异常

XMLStreamException - 如果所需值不匹配。

hasNext

public boolean hasNext()
                throws XMLStreamException

说明从界面复制： XMLStreamReader

如果有更多的解析事件，返回true，如果没有更多的事件，返回false。 如果XMLStreamReader的当前状态为END_DOCUMENT，则此方法将返回false

Specified by:

hasNext在接口 XMLStreamReader

结果

如果有更多事件，则为true，否则为false

异常

XMLStreamException - 如果检测到下一个状态存在致命错误

close

public void close()
           throws XMLStreamException

说明从界面复制： XMLStreamReader

释放与此Reader相关联的任何资源。 此方法不会关闭底层输入源。

Specified by:

close在接口 XMLStreamReader

异常

XMLStreamException - 如果有错误释放相关资源

getNamespaceURI

public String getNamespaceURI(String prefix)

说明从界面复制： XMLStreamReader

返回给定前缀的uri。 返回的uri取决于处理器的当前状态。

注意： “xml”前缀的绑定方式与“http://www.w3.org/XML/1998/namespace”的Namespaces in XML规范中定义。

注意： 'xmlns'前缀必须解析为以下命名空间http://www.w3.org/2000/xmlns/

Specified by:

getNamespaceURI在接口 XMLStreamReader

参数

prefix - 查找的前缀可能不为空

结果

绑定到给定前缀的uri，如果没有绑定则为null

getNamespaceContext

public NamespaceContext getNamespaceContext()

说明从界面： XMLStreamReader复制

返回当前位置的只读命名空间上下文。 上下文是短暂的，只有在对next（）的调用才能更改读取器的状态时才有效。

Specified by:

getNamespaceContext在接口 XMLStreamReader

结果

返回一个命名空间上下文

isStartElement

public boolean isStartElement()

说明从界面： XMLStreamReader复制

如果光标指向起始标记（否则为false），则返回true

Specified by:

isStartElement在界面 XMLStreamReader

结果

如果光标指向起始标记，则为true，否则为false

isEndElement

public boolean isEndElement()

说明从界面： XMLStreamReader复制

如果光标指向结束标记（否则为false），则返回true

Specified by:

isEndElement在接口 XMLStreamReader

结果

如果光标指向结束标记，则为true，否则为false

isCharacters

public boolean isCharacters()

说明从界面： XMLStreamReader复制

如果光标指向字符数据事件，则返回true

Specified by:

isCharacters在界面 XMLStreamReader

结果

如果光标指向字符数据，则为true，否则为false

isWhiteSpace

public boolean isWhiteSpace()

从接口复制： XMLStreamReader

如果游标指向由所有空格组成的字符数据事件，则返回true

Specified by:

isWhiteSpace在接口 XMLStreamReader

结果

如果光标指向所有空格，则为true，否则为false

getAttributeValue

public String getAttributeValue(String namespaceUri,
                                String localName)

说明从界面复制： XMLStreamReader

返回具有命名空间和localName的属性的归一化属性值如果namespaceURI为空，则不会检查命名空间是否相等

Specified by:

getAttributeValue在接口 XMLStreamReader

参数

namespaceUri - 属性的命名空间

localName - localName的本地名称，不能为空

结果

返回属性的值，如果没有找到则返回null

getAttributeCount

public int getAttributeCount()

说明从界面复制： XMLStreamReader

返回此START_ELEMENT上的属性数量，此方法仅适用于START_ELEMENT或ATTRIBUTE。 此计数不包括命名空间定义。 属性指数为零。

Specified by:

getAttributeCount在界面 XMLStreamReader

结果

返回属性数

getAttributeName

public QName getAttributeName(int index)

说明从界面复制： XMLStreamReader

返回提供的索引处的属性的qname

Specified by:

getAttributeName在界面 XMLStreamReader

参数

index - index的位置

结果

属性的QName

getAttributePrefix

public String getAttributePrefix(int index)

说明从界面复制： XMLStreamReader

在提供的索引处返回此属性的前缀

Specified by:

getAttributePrefix在接口 XMLStreamReader

参数

index - index的位置

结果

属性的前缀

getAttributeNamespace

public String getAttributeNamespace(int index)

描述从界面复制： XMLStreamReader

返回在提供的索引处的属性的命名空间

Specified by:

getAttributeNamespace在接口 XMLStreamReader

参数

index - index的位置

结果

命名空间URI（可以为空）

getAttributeLocalName

public String getAttributeLocalName(int index)

说明从界面复制： XMLStreamReader

返回提供的索引处的属性的localName

Specified by:

getAttributeLocalName在界面 XMLStreamReader

参数

index - index的位置

结果

该属性的localName

getAttributeType

public String getAttributeType(int index)

描述从界面复制： XMLStreamReader

返回提供的索引处的属性的XML类型

Specified by:

getAttributeType在接口 XMLStreamReader

参数

index - index的位置

结果

属性的XML类型

getAttributeValue

public String getAttributeValue(int index)

描述从界面复制： XMLStreamReader

返回索引处的属性值

Specified by:

getAttributeValue在界面 XMLStreamReader

参数

index - index的位置

结果

属性值

isAttributeSpecified

public boolean isAttributeSpecified(int index)

说明从界面复制： XMLStreamReader

返回一个布尔值，表示此属性是否默认创建

Specified by:

isAttributeSpecified在界面 XMLStreamReader

参数

index - index的位置

结果

如果这是默认属性，则为true

getNamespaceCount

public int getNamespaceCount()

说明从界面复制： XMLStreamReader

返回在此START_ELEMENT或END_ELEMENT上声明的命名空间数，此方法仅适用于START_ELEMENT，END_ELEMENT或NAMESPACE。 在END_ELEMENT上，计数是将要超出范围的命名空间。 这相当于SAX回调对终端元素事件报告的信息。

Specified by:

getNamespaceCount在接口 XMLStreamReader

结果

返回此特定元素上的命名空间声明的数量

getNamespacePrefix

public String getNamespacePrefix(int index)

说明从接口： XMLStreamReader复制

返回在索引处声明的命名空间的前缀。 如果这是默认命名空间声明，则返回null

Specified by:

getNamespacePrefix在接口 XMLStreamReader

参数

index - 命名空间声明的位置

结果

返回命名空间前缀

getNamespaceURI

public String getNamespaceURI(int index)

说明从界面： XMLStreamReader复制

返回在索引处声明的命名空间的uri。

Specified by:

getNamespaceURI在界面 XMLStreamReader

参数

index - 命名空间声明的位置

结果

返回命名空间uri

getEventType

public int getEventType()

说明从界面复制： XMLStreamReader

返回指示光标指向的事件类型的整数代码。

Specified by:

getEventType在界面 XMLStreamReader

getText

public String getText()

描述从接口： XMLStreamReader复制

以字符串形式返回解析事件的当前值，返回CHARACTERS事件的字符串值，返回COMMENT的值，ENTITY_REFERENCE的替换值，CDATA部分的字符串值，SPACE的字符串值事件或DTD的内部子集的String值。 如果ENTITY_REFERENCE已解决，任何字符数据将被报告为CHARACTERS事件。

Specified by:

getText在界面 XMLStreamReader

结果

当前文本或null

getTextCharacters

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

说明从界面： XMLStreamReader复制

获取与CHARACTERS，SPACE或CDATA事件关联的文本。 启动“sourceStart”的文本将从“targetStart”开始复制到“target”中。 最多可以复制“长度”字符。 返回实际复制的字符数。 “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”的长度。

Specified by:

getTextCharacters在接口 XMLStreamReader

参数

sourceStart - 要复制的源数组中的第一个字符的索引

target - 目标数组

targetStart - 目标数组中的起始偏移量

length - 要复制的字符数

结果

实际复制的字符数

异常

XMLStreamException - 如果底层XML源格式不正确

getTextCharacters

public char[] getTextCharacters()

从接口复制： XMLStreamReader

返回一个包含此事件中的字符的数组。 这个数组应该被视为只读和暂时的。 即，数组将包含文本字符，直到XMLStreamReader移动到下一个事件。 尝试在该时间之后保持字符阵列或修改数组的内容是违反该接口的合同。

Specified by:

getTextCharacters中的 XMLStreamReader

结果

当前文本或空数组

getTextStart

public int getTextStart()

说明从界面： XMLStreamReader复制

返回文本字符数组中存在第一个字符（该文本事件）的偏移量。

Specified by:

getTextStart在接口 XMLStreamReader

getTextLength

public int getTextLength()

描述从界面： XMLStreamReader复制

返回文本字符数组中此Text事件的字符序列长度。

Specified by:

getTextLength在界面 XMLStreamReader

getEncoding

public String getEncoding()

说明从界面复制： XMLStreamReader

如果已知返回输入编码，如果未知则返回null。

Specified by:

getEncoding在接口 XMLStreamReader

结果

该实例的编码或null

hasText

public boolean hasText()

说明从界面复制： XMLStreamReader

如果当前事件有文本，则返回true，否则返回false以下事件具有文本：CHARACTERS，DTD，ENTITY_REFERENCE，COMMENT，SPACE

Specified by:

hasText在界面 XMLStreamReader

getLocation

public Location getLocation()

说明从界面： XMLStreamReader复制

返回处理器的当前位置。 如果位置未知，则处理器应返回Location的实现，该位置返回-1的位置，对于publicId和systemId为null。 位置信息仅在调用next（）时有效。

Specified by:

getLocation在界面 XMLStreamReader

getName

public QName getName()

说明从界面复制： XMLStreamReader

返回当前START_ELEMENT或END_ELEMENT活动的QName

Specified by:

getName在接口 XMLStreamReader

结果

当前START_ELEMENT或END_ELEMENT活动的QName

getLocalName

public String getLocalName()

说明从界面复制： XMLStreamReader

返回当前事件的（本地）名称。 START_ELEMENT或END_ELEMENT返回当前元素的（本地）名称。 对于ENTITY_REFERENCE，它返回实体名称。 目前的活动必须是START_ELEMENT或END_ELEMENT，或ENTITY_REFERENCE

Specified by:

getLocalName在界面 XMLStreamReader

结果

localName

hasName

public boolean hasName()

说明从界面复制： XMLStreamReader

如果当前事件有一个名称（是START_ELEMENT或END_ELEMENT）返回false则返回true

Specified by:

hasName在界面 XMLStreamReader

getNamespaceURI

public String getNamespaceURI()

说明从界面复制： XMLStreamReader

如果当前事件是START_ELEMENT或END_ELEMENT，则此方法返回前缀或缺省命名空间的URI。 如果事件没有前缀，则返回null。

Specified by:

getNamespaceURI在界面 XMLStreamReader

结果

绑定到此元素前缀的URI，默认命名空间或null

getPrefix

public String getPrefix()

描述从界面： XMLStreamReader复制

返回当前事件的前缀，如果事件没有前缀，则返回null

Specified by:

getPrefix在接口 XMLStreamReader

结果

前缀或null

getVersion

public String getVersion()

说明从界面复制： XMLStreamReader

获取在xml声明中声明的xml版本如果没有声明，则返回null

Specified by:

getVersion在界面 XMLStreamReader

结果

XML版本或null

isStandalone

public boolean isStandalone()

说明从界面： XMLStreamReader复制

从xml声明获取独立声明

Specified by:

isStandalone在界面 XMLStreamReader

结果

如果这是独立的，则为true，否则为false

standaloneSet

public boolean standaloneSet()

说明从界面复制： XMLStreamReader

检查文档中是否设置了独立的

Specified by:

standaloneSet在界面 XMLStreamReader

结果

如果在文档中设置了独立，则为true，否则为false

getCharacterEncodingScheme

public String getCharacterEncodingScheme()

说明从界面复制： XMLStreamReader

返回在xml声明中声明的字符编码如果没有声明，则返回null

Specified by:

getCharacterEncodingScheme在界面 XMLStreamReader

结果

在文档中声明的编码或空值

getPITarget

public String getPITarget()

说明从界面复制： XMLStreamReader

获取处理指令的目标

Specified by:

getPITarget在界面 XMLStreamReader

结果

目标或null

getPIData

public String getPIData()

说明从界面复制： XMLStreamReader

获取处理指令的数据部分

Specified by:

getPIData在接口 XMLStreamReader

结果

数据或null

getProperty

public Object getProperty(String name)

说明从界面： XMLStreamReader复制

从底层实现获取特征/属性的值

Specified by:

getProperty在界面 XMLStreamReader

参数

name - 属性的名称，可能不为空

结果

物业的价值