模块 java.xml

软件包 javax.xml.transform.stax

Class StAXSource

java.lang.Object

javax.xml.transform.stax.StAXSource

实现的所有接口

Source

public class StAXSource
extends Object
implements Source

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

StAXSource s在处理期间消耗，不可重复使用。

从以下版本开始：

1.6

另请参见：

JSR 173: Streaming API for XML ， XMLStreamReader ， XMLEventReader

字段汇总

字段

变量和类型	字段	描述
static String	FEATURE	如果 TransformerFactory.getFeature(String name)在将此值作为参数传递时返回true，则Transformer支持此类型的Source输入。

构造方法摘要

构造方法

构造器	描述
StAXSource(XMLEventReader xmlEventReader)	通过提供XMLEventReader创建StAXSource的新实例。
StAXSource(XMLStreamReader xmlStreamReader)	通过提供XMLStreamReader创建StAXSource的新实例。

方法摘要

变量和类型	方法	描述
String	getSystemId()	获取此 StAXSource使用的系统标识符。
XMLEventReader	getXMLEventReader()	获取此 XMLEventReader使用的 StAXSource 。
XMLStreamReader	getXMLStreamReader()	获取此 XMLStreamReader使用的 StAXSource 。
boolean	isEmpty()	指示 StAXSource对象是否为空。
void	setSystemId(String systemId)	在 StAXSource的上下文中，不明确设置系统标识符。

声明方法的类 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输入。

另请参见：

常数字段值

构造方法详细信息

StAXSource

public StAXSource(XMLEventReader xmlEventReader)
           throws XMLStreamException

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

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)

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

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 in interface Source

结果

StAXSource使用的系统标识符。

isEmpty

public boolean isEmpty()

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

Specified by:

isEmpty ，界面 Source

结果

unconditionally false