Module java.xml

Package javax.xml.transform.stax

Class StAXSource

java.lang.Object

javax.xml.transform.stax.StAXSource

所有已实现的接口:

Source

       public class StAXSource extends Object implements Source
      

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

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

自1.6版本起:

1.6

参见:

• JSR 173: XML的流API
• XMLStreamReader
• XMLEventReader

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FEATURE	如果通过此值作为参数调用TransformerFactory.getFeature(String name)返回true，则Transformer支持此类型的Source输入。

Constructor Summary

Constructors

Constructor	Description
StAXSource(XMLEventReader xmlEventReader)	通过提供XMLEventReader创建StAXSource的新实例。
StAXSource(XMLStreamReader xmlStreamReader)	通过提供XMLStreamReader创建StAXSource的新实例。

Method Summary

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

Methods declared in class java.lang.Object

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

Field Details

FEATURE

             public static final String FEATURE
            

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

参见:

• 常量字段值

Constructor Details

StAXSource

             public StAXSource(XMLEventReader xmlEventReader) throws XMLStreamException
            

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

XMLEventReader必须是非null引用。

XMLEventReader必须处于XMLStreamConstants.START_DOCUMENT或XMLStreamConstants.START_ELEMENT状态。

参数:

xmlEventReader - 用于创建此StAXSource的XMLEventReader。

抛出:

XMLStreamException - 如果xmlEventReader访问引发Exception。

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 - 用于创建此StAXSource的XMLStreamReader。

抛出:

IllegalArgumentException - 如果xmlStreamReader == null。

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

Method Details

getXMLEventReader

             public XMLEventReader getXMLEventReader()
            

获取此StAXSource使用的XMLEventReader。

如果使用XMLStreamReader创建此StAXSource，则XMLEventReader将为null。

返回:

此StAXSource使用的XMLEventReader。

getXMLStreamReader

             public XMLStreamReader getXMLStreamReader()
            

获取此StAXSource使用的XMLStreamReader。

如果使用XMLEventReader创建此StAXSource，则XMLStreamReader将为null。

返回:

此StAXSource使用的XMLStreamReader。

setSystemId

             public void setSystemId(String systemId)
            

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

此方法始终会抛出一个UnsupportedOperationException。

指定者:

setSystemId 在接口 Source中

参数:

systemId - 忽略。

抛出:

UnsupportedOperationException - 此方法始终会抛出。

getSystemId

             public String getSystemId()
            

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

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

系统标识符可能为null或空的"" String。

指定者:

getSystemId 在接口 Source中

返回:

此StAXSource使用的系统标识符。

isEmpty

             public boolean isEmpty()
            

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

指定者:

isEmpty 在接口 Source中

返回:

无条件为false