uTools-Manuals/docs/java/org/xml/sax/DocumentHandler.html

<div class="header">
<div class="subTitle">
     compact2, compact3 
   </div>
<div class="subTitle">
     org.xml.sax 
   </div>
<h2 class="title" title="Interface DocumentHandler">Interface DocumentHandler</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
        所有已知实现类：
       </dt>
<dd>
<span><a href="../../../org/xml/sax/HandlerBase.html" title="在org.xml.sax中的类">HandlerBase</a> ， <a href="../../../org/xml/sax/helpers/ParserAdapter.html" title="org.xml.sax.helpers中的类">ParserAdapter</a></span>
</dd>
</dl>
<hr/>
<div class="block">
<span><span class="deprecatedLabel">已弃用</span></span>
<div class="block">
<span><span class="deprecationComment">该接口已被SAX2 <a href="../../../org/xml/sax/ContentHandler.html" title="org.xml.sax中的接口"><code>ContentHandler</code></a>接口所取代，其中包括命名空间支持。</span></span>
</div>
</div> <br/> <pre>public interface <span class="typeNameLabel">DocumentHandler</span></pre>
<div class="block">
<span>接收一般文件事件通知。</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>这是SAX1的主要事件处理界面;</span> <span>在SAX2中，它已被<a href="../../../org/xml/sax/ContentHandler.html" title="org.xml.sax中的接口"><code>ContentHandler</code>替代</a> ，它提供了命名空间支持和报告跳过的实体。</span> <span>该接口仅包含在SAX2中，以支持传统的SAX1应用。</span> </p>
<p> <span>此界面中的事件顺序非常重要，并且反映了文档本身中信息的顺序。</span> <span>例如，所有元素的内容（字符数据，处理指令和/或子元素）将按顺序显示在startElement事件和相应的endElement事件之间。</span> </p>
<p> <span>不想实现整个接口的应用程序编写者可以从实现默认功能的HandlerBase派生一个类;</span> <span>解析器编写者可以实例化HandlerBase来获取默认处理程序。</span> <span>应用程序可以使用通过setDocumentLocator方法由Parser提供的Locator接口找到任何文档事件的位置。</span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始：</span>
</dt>
<dd>
         SAX 1.0 
       </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../org/xml/sax/Parser.html#setDocumentHandler-org.xml.sax.DocumentHandler-"><code>Parser.setDocumentHandler(org.xml.sax.DocumentHandler)</code></a> ， <a href="../../../org/xml/sax/Locator.html" title="org.xml.sax中的接口"><code>Locator</code></a> ， <a href="../../../org/xml/sax/HandlerBase.html" title="在org.xml.sax中的类"><code>HandlerBase</code></a></span>
</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>
<span class="tableTab" id="t6"><span><a href="javascript:show(32);">弃用的方法</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/DocumentHandler.html#characters-char:A-int-int-">characters</a></span>(char[] ch, int start, int length)</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
              接收字符数据通知。 
            </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/DocumentHandler.html#endDocument--">endDocument</a></span>()</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
              接收文件结束的通知。 
            </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/DocumentHandler.html#endElement-java.lang.String-">endElement</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> name)</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
              接收元素结尾的通知。 
            </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/DocumentHandler.html#ignorableWhitespace-char:A-int-int-">ignorableWhitespace</a></span>(char[] ch, int start, int length)</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<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/DocumentHandler.html#processingInstruction-java.lang.String-java.lang.String-">processingInstruction</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> target, <a href="../../../java/lang/String.html" title="class in java.lang">String</a> data)</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
              接收处理指令的通知。 
            </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/DocumentHandler.html#setDocumentLocator-org.xml.sax.Locator-">setDocumentLocator</a></span>(<a href="../../../org/xml/sax/Locator.html" title="interface in org.xml.sax">Locator</a> locator)</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
              接收一个查找SAX文档事件的起源的对象。 
            </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/DocumentHandler.html#startDocument--">startDocument</a></span>()</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
              接收文件开头的通知。 
            </div> </td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xml/sax/DocumentHandler.html#startElement-java.lang.String-org.xml.sax.AttributeList-">startElement</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> name, <a href="../../../org/xml/sax/AttributeList.html" title="interface in org.xml.sax">AttributeList</a> atts)</code>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
              接收元素开头的通知。 
            </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="setDocumentLocator-org.xml.sax.Locator-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setDocumentLocator</h4> <pre>void setDocumentLocator(<a href="../../../org/xml/sax/Locator.html" title="interface in org.xml.sax">Locator</a> locator)</pre>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>接收一个查找SAX文档事件的起源的对象。</span>
<p> <span>强烈鼓励SAX解析器（尽管不是绝对必要的）提供定位器：如果这样做，它必须通过在调用DocumentHandler接口中的任何其他方法之前调用该方法来将定位器提供给应用程序。</span> </p>
<p> <span>定位器允许应用程序确定任何文档相关事件的结束位置，即使解析器没有报告错误。</span> <span>通常，应用程序将使用此信息来报告其自身的错误（例如与应用程序业务规则不匹配的字符内容）。</span> <span>定位器返回的信息可能不足以与搜索引擎一起使用。</span> </p>
<p> <span>请注意，定位器将仅在调用此界面中的事件时返回正确的信息。</span> <span>应用程序不应在任何其他时间尝试使用它。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>locator</code> - 可以返回任何SAX文档事件的位置的对象。 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../org/xml/sax/Locator.html" title="org.xml.sax中的接口"><code>Locator</code></a></span>
</dd>
</dl> </li>
</ul> <a name="startDocument--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>startDocument</h4> <pre>void startDocument()
            throws <a href="../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>接收文件开头的通知。</span>
<p> <span>SAX解析器将仅在此接口中的任何其他方法或DTDHandler（除了setDocumentLocator之外）中调用此方法一次。</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> - 任何SAX异常，可能包含另一个异常。 
           </dd>
</dl> </li>
</ul> <a name="endDocument--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>endDocument</h4> <pre>void endDocument()
          throws <a href="../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>接收文件结束的通知。</span>
<p> <span>SAX解析器将仅调用此方法一次，这将是解析过程中调用的最后一个方法。</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> - 任何SAX异常，可能包装另一个异常。 
           </dd>
</dl> </li>
</ul> <a name="startElement-java.lang.String-org.xml.sax.AttributeList-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>startElement</h4> <pre>void startElement(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> name,
                  <a href="../../../org/xml/sax/AttributeList.html" title="interface in org.xml.sax">AttributeList</a> atts)
           throws <a href="../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>接收元素开头的通知。</span>
<p> <span>解析器将在XML文档中的每个元素的开头调用此方法;</span> <span>对于每个startElement（）事件（即使该元素为空）也将有一个相应的endElement（）事件。</span> <span>所有元素的内容将按照相应的endElement（）事件的顺序进行报告。</span> </p>
<p> <span>如果元素名称具有命名空间前缀，则仍将附加前缀。</span> <span>请注意，提供的属性列表将仅包含具有显式值（指定或默认值）的属性：#IMPLIED属性将被省略。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>name</code> - 元素类型名称。 
           </dd>
<dd>
<code>atts</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> - 任何SAX异常，可能包装另一个异常。 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../org/xml/sax/DocumentHandler.html#endElement-java.lang.String-"><code>endElement(java.lang.String)</code></a> ， <a href="../../../org/xml/sax/AttributeList.html" title="org.xml.sax中的接口"><code>AttributeList</code></a></span>
</dd>
</dl> </li>
</ul> <a name="endElement-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>endElement</h4> <pre>void endElement(<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 class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>接收元素结尾的通知。</span>
<p> <span>SAX解析器将在XML文档中的每个元素的末尾调用此方法;</span> <span>对于每个endElement（）事件（即使该元素为空）也将有一个相应的startElement（）事件。</span> </p>
<p> <span>如果元素名称具有命名空间前缀，则前缀仍将附加到名称。</span> </p>
</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> - 任何SAX异常，可能包装另一个异常。 
           </dd>
</dl> </li>
</ul> <a name="characters-char:A-int-int-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>characters</h4> <pre>void characters(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 class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>接收字符数据通知。</span>
<p> <span>Parser将调用此方法来报告每个字符数据块。</span> <span>SAX解析器可以在单个块中返回所有连续的字符数据，或者它们可以将其分割成多个块;</span> <span>但是，任何单个事件中的所有字符都必须来自相同的外部实体，以便定位器提供有用的信息。</span> </p>
<p> <span>应用程序不得尝试从指定范围之外的数组读取。</span> </p>
<p> <span>请注意，某些解析器将使用ignorableWhitespace（）方法（而不是此验证解析器）来报告空格。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>ch</code> - XML文档中的字符。 
           </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> - 任何SAX异常，可能包装另一个异常。 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<span><a href="../../../org/xml/sax/DocumentHandler.html#ignorableWhitespace-char:A-int-int-"><code>ignorableWhitespace(char[], int, int)</code></a> ， <a href="../../../org/xml/sax/Locator.html" title="org.xml.sax中的接口"><code>Locator</code></a></span>
</dd>
</dl> </li>
</ul> <a name="ignorableWhitespace-char:A-int-int-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>ignorableWhitespace</h4> <pre>void ignorableWhitespace(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 class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>在元素内容中接收到可忽略的空白的通知。</span>
<p> <span>验证解析器必须使用此方法来报告每个可忽略的空白块（参见W3C XML 1.0推荐，第2.10节）：非验证解析器也可以使用此方法，如果它们能够解析和使用内容模型。</span> </p>
<p> <span>SAX解析器可以在单个块中返回所有连续的空格，或者它们可以将其分割成多个块;</span> <span>但是，任何单个事件中的所有字符都必须来自相同的外部实体，以便定位器提供有用的信息。</span> </p>
<p> <span>应用程序不得尝试从指定范围之外的数组读取。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>ch</code> - XML文档中的字符。 
           </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> - 任何SAX异常，可能包装另一个异常。 
           </dd>
<dt>
<span class="seeLabel">另请参见：</span>
</dt>
<dd>
<a href="../../../org/xml/sax/DocumentHandler.html#characters-char:A-int-int-"><code>characters(char[], int, int)</code></a>
</dd>
</dl> </li>
</ul> <a name="processingInstruction-java.lang.String-java.lang.String-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>processingInstruction</h4> <pre>void processingInstruction(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> target,
                           <a href="../../../java/lang/String.html" title="class in java.lang">String</a> data)
                    throws <a href="../../../org/xml/sax/SAXException.html" title="class in org.xml.sax">SAXException</a></pre>
<div class="block">
<span class="deprecatedLabel">已弃用</span>
</div>
<div class="block">
<span>接收处理指令的通知。</span>
<p> <span>解析器将为发现的每个处理指令调用此方法一次：请注意，处理指令可能发生在主文档元素之前或之后。</span> </p>
<p> <span>SAX解析器不应使用此方法报告XML声明（XML 1.0，第2.8节）或文本声明（XML 1.0，第4.3.1节）。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>target</code> - 处理指令目标。 
           </dd>
<dd>
<code>data</code> - 处理指令数据，如果没有提供，则为null。 
           </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> - Any SAX exception, possibly wrapping another exception. 
           </dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>