uTools-Manuals/docs/java/org/xml/sax/ext/LexicalHandler.html

343 lines
17 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">
org.xml.sax.ext
</div>
<h2 class="title" title="Interface LexicalHandler">Interface LexicalHandler</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Known Subinterfaces:
</dt>
<dd>
<span><a href="../../../../javax/xml/transform/sax/TransformerHandler.html" title="javax.xml.transform.sax中的接口">TransformerHandler</a></span>
</dd>
</dl>
<dl>
<dt>
所有已知实现类:
</dt>
<dd>
<span><a href="../../../../org/xml/sax/ext/DefaultHandler2.html" title="org.xml.sax.ext中的类">DefaultHandler2</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public interface <span class="typeNameLabel">LexicalHandler</span></pre>
<div class="block">
<span>用于词汇事件的SAX2扩展处理程序。</span>
<blockquote>
<span><em>This module, both source code and documentation, is in the Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> See <a href="http://www.saxproject.org">http://www.saxproject.org</a> for further information.</span>
</blockquote>
<p> <span>这是一个可选的扩展处理程序用于SAX2提供有关XML文档的词法信息如注释和CDATA段边界。</span> <span>XML读取器不需要识别此处理程序它不是仅核心的SAX2发行版的一部分。</span> </p>
<p> <span>词法处理程序中的事件适用于整个文档而不仅仅是文档元素并且所有词法处理程序事件必须出现在内容处理程序的startDocument和endDocument事件之间。</span> </p>
<p> <span>要为XML读取器设置LexicalHandler请使用属性名称为<code>http://xml.org/sax/properties/lexical-handler</code><a href="../../../../org/xml/sax/XMLReader.html#setProperty-java.lang.String-java.lang.Object-"><code>setProperty</code></a>方法和实现此接口或null的对象作为值。</span> <span>如果读者没有报告词汇事件,那么当您尝试注册处理程序时,它会抛出一个<a href="../../../../org/xml/sax/SAXNotRecognizedException.html" title="在org.xml.sax中的类"><code>SAXNotRecognizedException</code></a></span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
SAX 2.0扩展1.0
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3"><span><a href="javascript:show(4);">抽象方法</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/xml/sax/ext/LexicalHandler.html#comment-char:A-int-int-">comment</a></span>(char[] ch, int start, int length)</code>
<div class="block">
在文档的任何位置报告XML注释。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/xml/sax/ext/LexicalHandler.html#endCDATA--">endCDATA</a></span>()</code>
<div class="block">
报告CDATA部分的结尾。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/xml/sax/ext/LexicalHandler.html#endDTD--">endDTD</a></span>()</code>
<div class="block">
报告DTD声明的结尾。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/xml/sax/ext/LexicalHandler.html#endEntity-java.lang.String-">endEntity</a></span>(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> name)</code>
<div class="block">
报告实体的结束。
</div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/xml/sax/ext/LexicalHandler.html#startCDATA--">startCDATA</a></span>()</code>
<div class="block">
报告CDATA部分的开始。
</div> </td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/xml/sax/ext/LexicalHandler.html#startDTD-java.lang.String-java.lang.String-java.lang.String-">startDTD</a></span>(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> name, <a href="../../../../java/lang/String.html" title="class in java.lang">String</a> publicId, <a href="../../../../java/lang/String.html" title="class in java.lang">String</a> systemId)</code>
<div class="block">
报告DTD声明的开始如果有的话。
</div> </td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/xml/sax/ext/LexicalHandler.html#startEntity-java.lang.String-">startEntity</a></span>(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> name)</code>
<div class="block">
报告一些内部和外部XML实体的开始。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="startDTD-java.lang.String-java.lang.String-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>startDTD</h4> <pre>void startDTD(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> name,
<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> publicId,
<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> systemId)
throws <a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span>报告DTD声明的开始如果有的话。</span>
<p> <span>此方法用于报告DOCTYPE声明的开始;</span> <span>如果文档没有DOCTYPE声明则不会调用此方法。</span> </p>
<p> <span>通过<a href="../../../../org/xml/sax/DTDHandler.html" title="org.xml.sax中的接口"><code>DTDHandler</code></a><a href="../../../../org/xml/sax/ext/DeclHandler.html" title="org.xml.sax.ext中的接口"><code>DeclHandler</code></a>事件报告的所有声明必须出现在startDTD和<a href="../../../../org/xml/sax/ext/LexicalHandler.html#endDTD--"><code>endDTD</code></a>事件之间。</span> <span>假设声明属于内部DTD子集除非它们出现在<a href="../../../../org/xml/sax/ext/LexicalHandler.html#startEntity-java.lang.String-"><code>startEntity</code></a><a href="../../../../org/xml/sax/ext/LexicalHandler.html#endEntity-java.lang.String-"><code>endEntity</code></a>事件之间。</span> <span>来自DTD的注释和处理指令也应在startDTD和endDTD事件之间以其原始的逻辑发生顺序报告;</span> <span>但是它们不需要出现在相对于DTDHandler或DeclHandler事件的正确位置。</span> </p>
<p> <span>请注意start / endDTD事件将显示在ContentHandler的start / endDocument事件之前和第一个<a href="../../../../org/xml/sax/ContentHandler.html#startElement-java.lang.String-java.lang.String-java.lang.String-org.xml.sax.Attributes-"><code>startElement</code></a>事件之前。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>name</code> - 文档类型名称。
</dd>
<dd>
<code>publicId</code> - 外部DTD子集的已声明的公共标识符如果未声明则为null。
</dd>
<dd>
<span><code>systemId</code> - 外部DTD子集的已声明的系统标识符如果未声明则为null。</span>
<span>请注意这不是针对文档基础URI解决的。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></code> - 应用程序可能会引发异常。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../org/xml/sax/ext/LexicalHandler.html#endDTD--"><code>endDTD()</code></a>
<a href="../../../../org/xml/sax/ext/LexicalHandler.html#startEntity-java.lang.String-"><code>startEntity(java.lang.String)</code></a>
</dd>
</dl> </li>
</ul> <a name="endDTD--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>endDTD</h4> <pre>void endDTD()
throws <a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span>报告DTD声明的结尾。</span>
<p> <span>此方法用于报告DOCTYPE声明的结尾;</span> <span>如果文档没有DOCTYPE声明则不会调用此方法。</span> </p>
</div>
<dl>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></code> - 应用程序可能会引发异常。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../org/xml/sax/ext/LexicalHandler.html#startDTD-java.lang.String-java.lang.String-java.lang.String-"><code>startDTD(java.lang.String, java.lang.String, java.lang.String)</code></a>
</dd>
</dl> </li>
</ul> <a name="startEntity-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>startEntity</h4> <pre>void startEntity(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> name)
throws <a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span>报告一些内部和外部XML实体的开始。</span>
<p> <span>参数实体包括外部DTD子集的报告是可选的报告LexicalHandler事件的SAX2驱动程序可能无法实现;</span> <span>您可以使用<code>http://xml.org/sax/features/lexical-handler/parameter-entities</code>功能来查询或控制参数实体的报告。</span> </p>
<p> <span>一般实体以其常规名称报告,参数实体的名称前面有''外部DTD子集具有伪实体名称“[dtd]”。</span> </p>
<p> <span>当SAX2驱动程序提供这些事件时所有其他事件必须正确嵌套在开始/结束实体事件中。</span> <span>不需要额外要求<a href="../../../../org/xml/sax/ext/DeclHandler.html" title="org.xml.sax.ext中的接口"><code>DeclHandler</code></a><a href="../../../../org/xml/sax/DTDHandler.html" title="org.xml.sax中的接口"><code>DTDHandler</code></a>事件正确订购。</span> </p>
<p> <span>请注意,跳过的实体将通过<a href="../../../../org/xml/sax/ContentHandler.html#skippedEntity-java.lang.String-"><code>skippedEntity</code></a>事件进行报告这是ContentHandler界面的一部分。</span> </p>
<p> <span>由于SAX使用的流媒体事件模型在任何情况下都不能报告某些实体边界</span> </p>
<ul>
<li> <span>属性值内的一般实体</span> </li>
<li> <span>声明中的参数实体</span> </li>
</ul>
<p> <span>这些将被默默地扩大,没有指示原始实体边界在哪里。</span> </p>
<p> <span>还要注意,不会报告字符引用的边界(这不是真正的实体)。</span> </p>
<p> <span>所有的start / endEntity事件必须正确嵌套。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<span><code>name</code> - 实体的名称。</span>
<span>如果它是参数实体,则名称将以''开头如果是外部DTD子集它将为“[dtd]”。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></code> - 应用程序可能引发异常。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../org/xml/sax/ext/LexicalHandler.html#endEntity-java.lang.String-"><code>endEntity(java.lang.String)</code></a>
<a href="../../../../org/xml/sax/ext/DeclHandler.html#internalEntityDecl-java.lang.String-java.lang.String-"><code>DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)</code></a>
<a href="../../../../org/xml/sax/ext/DeclHandler.html#externalEntityDecl-java.lang.String-java.lang.String-java.lang.String-"><code>DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)</code></a>
</dd>
</dl> </li>
</ul> <a name="endEntity-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>endEntity</h4> <pre>void endEntity(<a href="../../../../java/lang/String.html" title="class in java.lang">String</a> name)
throws <a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
报告实体的结束。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>name</code> - 正在结束的实体的名称。
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></code> - 应用程序可能会引发异常。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../org/xml/sax/ext/LexicalHandler.html#startEntity-java.lang.String-"><code>startEntity(java.lang.String)</code></a>
</dd>
</dl> </li>
</ul> <a name="startCDATA--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>startCDATA</h4> <pre>void startCDATA()
throws <a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span>报告CDATA部分的开始。</span>
<p> <span>CDATA部分的内容将通过常规<a href="../../../../org/xml/sax/ContentHandler.html#characters-char:A-int-int-"><code>characters</code></a>事件报告;</span> <span>此事件仅用于报告边界。</span> </p>
</div>
<dl>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></code> - 应用程序可能会引发异常。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../org/xml/sax/ext/LexicalHandler.html#endCDATA--"><code>endCDATA()</code></a>
</dd>
</dl> </li>
</ul> <a name="endCDATA--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>endCDATA</h4> <pre>void endCDATA()
throws <a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
报告CDATA部分的结尾。
</div>
<dl>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></code> - 应用程序可能引发异常。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../org/xml/sax/ext/LexicalHandler.html#startCDATA--"><code>startCDATA()</code></a>
</dd>
</dl> </li>
</ul> <a name="comment-char:A-int-int-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>comment</h4> <pre>void comment(char[] ch,
int start,
int length)
throws <a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span>在文档的任何位置报告XML注释。</span>
<p> <span>此回调将用于文档元素内部或外部的注释包括外部DTD子集中的注释如果已读</span> <span>DTD中的注释必须正确嵌套在start / endDTD和start / endEntity事件如果使用中。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>ch</code> - 在注释中保存
<code>ch</code>的数组。
</dd>
<dd>
<code>start</code> - 数组中的起始位置。
</dd>
<dd>
<code>length</code> - 要从数组使用的字符数。
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></code> - 应用程序可能会引发异常。
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>