Module java.xml

软件包 javax.xml.transform.stax

Class StAXSource

java.lang.Object

javax.xml.transform.stax.StAXSource

All Implemented Interfaces:

Source

public class StAXSource
extends Object
implements Source

以StAX阅读器的形式（即XMLStreamReader或XMLEventReader）作为XML Source的持有人。 StAXSource可以在接受所有情况下使用Source ，例如Transformer ， Validator其接受Source作为输入。

StAXSource在处理过程中消耗，不可重复使用。

从以下版本开始：

1.6

另请参见：

JSR 173: Streaming API for XML ， XMLStreamReader ， XMLEventReader

Field Summary

Fields

Modifier and Type	Field	描述
static String	FEATURE	如果传递此值作为参数，则 TransformerFactory.getFeature(String name)返回true，则Transformer支持此类型的Source输入。

构造方法摘要

构造方法

Constructor	描述
StAXSource(XMLEventReader xmlEventReader)	创建的新实例StAXSource通过提供一个XMLEventReader 。
StAXSource(XMLStreamReader xmlStreamReader)	创建的新实例StAXSource通过提供一个XMLStreamReader 。

方法摘要

Modifier and Type	方法	描述
String	getSystemId()	获取此 StAXSource使用的系统标识符。
XMLEventReader	getXMLEventReader()	获取此 XMLEventReader使用的 StAXSource 。
XMLStreamReader	getXMLStreamReader()	获取 XMLStreamReader用这个 StAXSource 。
boolean	isEmpty()	指示 StAXSource对象是否为空。
void	setSystemId(String systemId)	在 StAXSource的上下文中，显式设置系统标识符是不合适的。

Methods inherited from class java.lang.Object

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

字段详细信息

FEATURE

public static final String FEATURE

如果传递此值作为参数，则 TransformerFactory.getFeature(String name)返回true，则Transformer支持此类型的Source输入。

另请参见：

Constant Field Values

构造方法详细信息

StAXSource

public StAXSource(XMLEventReader xmlEventReader)
           throws XMLStreamException

创建的新实例StAXSource通过提供一个XMLEventReader 。

XMLEventReader必须是非null参考。

XMLEventReader必须在XMLStreamConstants.START_DOCUMENT或XMLStreamConstants.START_ELEMENT状态。

参数

xmlEventReader - XMLEventReader用于创建这个 StAXSource 。

异常

XMLStreamException - 如果 xmlEventReader访问 异常一个 异常 。

IllegalArgumentException - 如果是 xmlEventReader == null 。

IllegalStateException - 如果 xmlEventReader不在 XMLStreamConstants.START_DOCUMENT或 XMLStreamConstants.START_ELEMENT状态。

StAXSource

public StAXSource(XMLStreamReader xmlStreamReader)

创建的新实例StAXSource通过提供一个XMLStreamReader 。

XMLStreamReader必须是非null参考。

XMLStreamReader必须在XMLStreamConstants.START_DOCUMENT或XMLStreamConstants.START_ELEMENT状态。

参数

xmlStreamReader - XMLStreamReader用于创建这个 StAXSource 。

异常

IllegalArgumentException - 如果 xmlStreamReader == null 。

IllegalStateException - 如果 xmlStreamReader不在 XMLStreamConstants.START_DOCUMENT或 XMLStreamConstants.START_ELEMENT状态。

方法详细信息

getXMLEventReader

public XMLEventReader getXMLEventReader()

获取XMLEventReader使用的StAXSource 。

XMLEventReader将为null 。 如果这个StAXSource是用一个XMLStreamReader创建的。

结果

XMLEventReader这个 StAXSource 。

getXMLStreamReader

public XMLStreamReader getXMLStreamReader()

获取XMLStreamReader使用的StAXSource 。

XMLStreamReader将是null如果这个StAXSource是用一个XMLEventReader创建的。

结果

XMLStreamReader由这个 StAXSource 。

setSystemId

public void setSystemId(String systemId)

在StAXSource的上下文中，显式设置系统标识符是不合适的。 用于构造此StAXSource的XMLStreamReader或XMLEventReader确定了XML源的系统标识符。

这个方法总是抛出一个UnsupportedOperationException 。

Specified by:

setSystemId在接口 Source

参数

systemId - 忽略。

异常

UnsupportedOperationException - 总是被这种方法抛出。

getSystemId

public String getSystemId()

获取此StAXSource使用的系统标识符。

查询用于构造此StAXSource的XMLStreamReader或XMLEventReader ，以确定XML源的系统标识符。

系统标识符可以是null或空的"" String 。

Specified by:

getSystemId在接口 Source

结果

系统标识符由此 StAXSource 。

isEmpty

public boolean isEmpty()

指示StAXSource对象是否为空。 由于StAXSource对象永远不能为空，此方法总是返回false。

Specified by:

isEmpty在接口 Source

结果

unconditionally false