364 lines
18 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
compact2, compact3
</div>
<div class="subTitle">
javax.xml.transform.stax
</div>
<h2 class="title" title="Class StAXSource">Class StAXSource</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>javax.xml.transform.stax.StAXSource</li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Implemented Interfaces:
</dt>
<dd>
<span><a href="../../../../javax/xml/transform/Source.html" title="javax.xml.transform中的接口">Source</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public class <span class="typeNameLabel">StAXSource</span>
extends <a href="../../../../java/lang/Object.html" title="class in java.lang">Object</a>
implements <a href="../../../../javax/xml/transform/Source.html" title="interface in javax.xml.transform">Source</a></pre>
<div class="block">
<p> <span>作为StAX阅读器形式的XML <a href="../../../../javax/xml/transform/Source.html" title="javax.xml.transform中的接口"><code>Source</code></a>的持有人,即<a href="../../../../javax/xml/stream/XMLStreamReader.html" title="javax.xml.stream中的接口"><code>XMLStreamReader</code></a><a href="../../../../javax/xml/stream/XMLEventReader.html" title="javax.xml.stream中的接口"><code>XMLEventReader</code></a></span> <span><code>StAXSource</code>可以在接受所有情况下使用<code>Source</code> ,例如<a href="../../../../javax/xml/transform/Transformer.html" title="javax.xml.transform中的类"><code>Transformer</code></a> <a href="../../../../javax/xml/validation/Validator.html" title="javax.xml.validation中的类"><code>Validator</code></a> ,其接受<code>Source</code>作为输入。</span> </p>
<p> <span><code>StAXSource</code>在处理过程中消耗,不可重复使用。</span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.6
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="http://jcp.org/en/jsr/detail?id=173">JSR 173: Streaming API for XML</a> <a href="../../../../javax/xml/stream/XMLStreamReader.html" title="javax.xml.stream中的接口"><code>XMLStreamReader</code></a> <a href="../../../../javax/xml/stream/XMLEventReader.html" title="javax.xml.stream中的接口"><code>XMLEventReader</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- --> </a> <h3>Field Summary</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption>
<span>Fields</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/transform/stax/StAXSource.html#FEATURE">FEATURE</a></span></code>
<div class="block">
如果
<a href="../../../../javax/xml/transform/TransformerFactory.html#getFeature-java.lang.String-"><code>TransformerFactory.getFeature(String name)</code></a>将该值作为参数传递时返回true则Transformer支持此类型的Source输入。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/xml/transform/stax/StAXSource.html#StAXSource-javax.xml.stream.XMLEventReader-">StAXSource</a></span>(<a href="../../../../javax/xml/stream/XMLEventReader.html" title="interface in javax.xml.stream">XMLEventReader</a> xmlEventReader)</code>
<div class="block">
<span>创建的新实例<code>StAXSource</code>通过提供一个<a href="../../../../javax/xml/stream/XMLEventReader.html" title="javax.xml.stream中的接口"><code>XMLEventReader</code></a></span>
</div> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/xml/transform/stax/StAXSource.html#StAXSource-javax.xml.stream.XMLStreamReader-">StAXSource</a></span>(<a href="../../../../javax/xml/stream/XMLStreamReader.html" title="interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader)</code>
<div class="block">
<span>创建的新实例<code>StAXSource</code>通过提供一个<a href="../../../../javax/xml/stream/XMLStreamReader.html" title="javax.xml.stream中的接口"><code>XMLStreamReader</code></a></span>
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t4"><span><a href="javascript:show(8);">具体的方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="../../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/transform/stax/StAXSource.html#getSystemId--">getSystemId</a></span>()</code>
<div class="block">
获取此StAXSource使用的系统
<code>StAXSource</code>
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../../javax/xml/stream/XMLEventReader.html" title="interface in javax.xml.stream">XMLEventReader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/transform/stax/StAXSource.html#getXMLEventReader--">getXMLEventReader</a></span>()</code>
<div class="block">
获取此
<code>XMLEventReader</code>使用的
<code>StAXSource</code>
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../../javax/xml/stream/XMLStreamReader.html" title="interface in javax.xml.stream">XMLStreamReader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/transform/stax/StAXSource.html#getXMLStreamReader--">getXMLStreamReader</a></span>()</code>
<div class="block">
获取此
<code>XMLStreamReader</code>使用的
<code>StAXSource</code>
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/transform/stax/StAXSource.html#setSystemId-java.lang.String-">setSystemId</a></span>(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> systemId)</code>
<div class="block">
<code>StAXSource</code>的上下文中,显式设置系统标识符是不合适的。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../../../java/lang/Object.html#clone--">clone</a>, <a href="../../../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../../../java/lang/Object.html#notify--">notify</a>, <a href="../../../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../../../java/lang/Object.html#toString--">toString</a>, <a href="../../../../java/lang/Object.html#wait--">wait</a>, <a href="../../../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- --> </a> <h3>字段详细信息</h3> <a name="FEATURE">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>FEATURE</h4> <pre>public static final <a href="../../../../java/lang/String.html" title="class in java.lang">String</a> FEATURE</pre>
<div class="block">
如果
<a href="../../../../javax/xml/transform/TransformerFactory.html#getFeature-java.lang.String-"><code>TransformerFactory.getFeature(String name)</code></a>将该值作为参数传递时返回true则Transformer支持此类型的Source输入。
</div>
<dl>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../constant-values.html#javax.xml.transform.stax.StAXSource.FEATURE">Constant Field Values</a>
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="StAXSource-javax.xml.stream.XMLEventReader-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>StAXSource</h4> <pre>public StAXSource(<a href="../../../../javax/xml/stream/XMLEventReader.html" title="interface in javax.xml.stream">XMLEventReader</a> xmlEventReader)
throws <a href="../../../../javax/xml/stream/XMLStreamException.html" title="class in javax.xml.stream">XMLStreamException</a></pre>
<div class="block">
<p> <span>创建的新实例<code>StAXSource</code>通过提供一个<a href="../../../../javax/xml/stream/XMLEventReader.html" title="javax.xml.stream中的接口"><code>XMLEventReader</code></a></span> </p>
<p> <span><code>XMLEventReader</code>必须是非<code>null</code>参考。</span> </p>
<p> <span><code>XMLEventReader</code>必须在<a href="../../../../javax/xml/stream/XMLStreamConstants.html#START_DOCUMENT"><code>XMLStreamConstants.START_DOCUMENT</code></a><a href="../../../../javax/xml/stream/XMLStreamConstants.html#START_ELEMENT"><code>XMLStreamConstants.START_ELEMENT</code></a>状态。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>xmlEventReader</code> -
<code>XMLEventReader</code>用于创建此
<code>StAXSource</code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../javax/xml/stream/XMLStreamException.html" title="class in javax.xml.stream">XMLStreamException</a></code> - 如果
<code>xmlEventReader</code>访问
<code>异常</code>了一个
<code>异常</code>
</dd>
<dd>
<code><a href="../../../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - 如果
<code>xmlEventReader</code> ==
<code>null</code>
</dd>
<dd>
<code><a href="../../../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果
<code>xmlEventReader</code>不在
<code>XMLStreamConstants.START_DOCUMENT</code>
<code>XMLStreamConstants.START_ELEMENT</code>状态。
</dd>
</dl> </li>
</ul> <a name="StAXSource-javax.xml.stream.XMLStreamReader-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>StAXSource</h4> <pre>public StAXSource(<a href="../../../../javax/xml/stream/XMLStreamReader.html" title="interface in javax.xml.stream">XMLStreamReader</a> xmlStreamReader)</pre>
<div class="block">
<p> <span>创建的新实例<code>StAXSource</code>通过提供一个<a href="../../../../javax/xml/stream/XMLStreamReader.html" title="javax.xml.stream中的接口"><code>XMLStreamReader</code></a></span> </p>
<p> <span><code>XMLStreamReader</code>必须是非<code>null</code>参考。</span> </p>
<p> <span><code>XMLStreamReader</code>必须在<a href="../../../../javax/xml/stream/XMLStreamConstants.html#START_DOCUMENT"><code>XMLStreamConstants.START_DOCUMENT</code></a><a href="../../../../javax/xml/stream/XMLStreamConstants.html#START_ELEMENT"><code>XMLStreamConstants.START_ELEMENT</code></a>状态。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>xmlStreamReader</code> -
<code>XMLStreamReader</code>用于创建此
<code>StAXSource</code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../java/lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - 如果
<code>xmlStreamReader</code> ==
<code>null</code>
</dd>
<dd>
<code><a href="../../../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果
<code>xmlStreamReader</code>不在
<code>XMLStreamConstants.START_DOCUMENT</code>
<code>XMLStreamConstants.START_ELEMENT</code>状态。
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getXMLEventReader--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getXMLEventReader</h4> <pre>public <a href="../../../../javax/xml/stream/XMLEventReader.html" title="interface in javax.xml.stream">XMLEventReader</a> getXMLEventReader()</pre>
<div class="block">
<p> <span>获取此<code>XMLEventReader</code>使用的<code>StAXSource</code></span> </p>
<p> <span><code>XMLEventReader</code>将会是<code>null</code></span> <span>如果这个<code>StAXSource</code>是用<code>XMLStreamReader</code>创建的。</span> </p>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<code>XMLEventReader</code>被这个
<code>StAXSource</code>
</dd>
</dl> </li>
</ul> <a name="getXMLStreamReader--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getXMLStreamReader</h4> <pre>public <a href="../../../../javax/xml/stream/XMLStreamReader.html" title="interface in javax.xml.stream">XMLStreamReader</a> getXMLStreamReader()</pre>
<div class="block">
<p> <span>获取此<code>XMLStreamReader</code>使用的<code>StAXSource</code></span> </p>
<p> <span><code>XMLStreamReader</code>将是<code>null</code>如果这<code>StAXSource</code>是用<code>XMLEventReader</code>创建的。</span> </p>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<code>XMLStreamReader</code>被这个
<code>StAXSource</code>
</dd>
</dl> </li>
</ul> <a name="setSystemId-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setSystemId</h4> <pre>public void setSystemId(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> systemId)</pre>
<div class="block">
<p> <span><code>StAXSource</code>的上下文中,显式设置系统标识符是不合适的。</span> <span>用于构造此<code>StAXSource</code><code>XMLStreamReader</code><code>XMLEventReader</code>确定了XML源的系统标识符。</span> </p>
<p> <span>这个方法<strong>总是</strong>抛出一个<a href="../../../../java/lang/UnsupportedOperationException.html" title="java.lang中的类"><code>UnsupportedOperationException</code></a></span> </p>
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../../../javax/xml/transform/Source.html#setSystemId-java.lang.String-">setSystemId</a></code>在界面
<code><a href="../../../../javax/xml/transform/Source.html" title="interface in javax.xml.transform">Source</a></code>
</dd>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>systemId</code> - 忽略。
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../java/lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> -
<strong>总是</strong>被这个方法抛出。
</dd>
</dl> </li>
</ul> <a name="getSystemId--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getSystemId</h4> <pre>public <a href="../../../../java/lang/String.html" title="class in java.lang">String</a> getSystemId()</pre>
<div class="block">
<p> <span>获取此StAXSource使用的系统<code>StAXSource</code></span> </p>
<p> <span>用于构建此<code>StAXSource</code><code>XMLStreamReader</code><code>XMLEventReader</code>进行查询以确定XML源的系统标识符。</span> </p>
<p> <span>系统标识符可以是<code>null</code>或空的<code>""</code> <code>String</code></span> </p>
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../../../javax/xml/transform/Source.html#getSystemId--">getSystemId</a></code>在接口
<code><a href="../../../../javax/xml/transform/Source.html" title="interface in javax.xml.transform">Source</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<code>StAXSource</code>使用的系统
<code>StAXSource</code>
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>