uTools-Manuals/docs/java/javax/tools/DocumentationTool.DocumentationTask.html

<div class="header">
<div class="subTitle">
     compact3 
   </div>
<div class="subTitle">
     javax.tools 
   </div>
<h2 class="title" title="Interface DocumentationTool.DocumentationTask">Interface DocumentationTool.DocumentationTask</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
         All Superinterfaces: 
       </dt>
<dd>
<span><a href="../../java/util/concurrent/Callable.html" title="java.util.concurrent中的接口">Callable</a> &lt; <a href="../../java/lang/Boolean.html" title="java.lang中的类">Boolean</a> &gt;</span>
</dd>
</dl>
<dl>
<dt>
         Enclosing interface: 
       </dt>
<dd>
<span><a href="../../javax/tools/DocumentationTool.html" title="javax.tools中的接口">DocumentationTool</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public static interface <span class="typeNameLabel">DocumentationTool.DocumentationTask</span>
extends <a href="../../java/util/concurrent/Callable.html" title="interface in java.util.concurrent">Callable</a>&lt;<a href="../../java/lang/Boolean.html" title="class in java.lang">Boolean</a>&gt;</pre>
<div class="block">
<span>表示文档任务的未来的接口。</span>
<span>任务尚未开始。</span>
<span>要启动任务，请调用<a href="../../javax/tools/DocumentationTool.DocumentationTask.html#call--">call</a>方法。</span>
<p> <span>在调用呼叫方法之前，可以配置任务的其他方面，例如，通过调用<a href="../../javax/tools/DocumentationTool.DocumentationTask.html#setLocale-java.util.Locale-">setLocale</a>方法。</span> </p>
</div> </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><a href="../../java/lang/Boolean.html" title="class in java.lang">Boolean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/tools/DocumentationTool.DocumentationTask.html#call--">call</a></span>()</code>
<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="../../javax/tools/DocumentationTool.DocumentationTask.html#setLocale-java.util.Locale-">setLocale</a></span>(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a> locale)</code>
<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="setLocale-java.util.Locale-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>setLocale</h4> <pre>void setLocale(<a href="../../java/util/Locale.html" title="class in java.util">Locale</a> locale)</pre>
<div class="block">
            设置格式化诊断和其他本地化数据时应用的区域设置。 
          </div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<span><code>locale</code> - 要申请的地区;</span>
<span><code>null</code>表示不适用于任何地区</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - 如果任务已经启动 
           </dd>
</dl> </li>
</ul> <a name="call--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>call</h4> <pre><a href="../../java/lang/Boolean.html" title="class in java.lang">Boolean</a> call()</pre>
<div class="block">
<span>执行此文档任务。</span>
<span>该任务只能执行一次。</span>
<span>对此方法的后续调用将抛出IllegalStateException。</span>
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../java/util/concurrent/Callable.html#call--">call</a></code>在接口 
            <code><a href="../../java/util/concurrent/Callable.html" title="interface in java.util.concurrent">Callable</a>&lt;<a href="../../java/lang/Boolean.html" title="class in java.lang">Boolean</a>&gt;</code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>如果且仅当所有文件被处理没有错误，则为真;</span>
<span>否则为假</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<span><code><a href="../../java/lang/RuntimeException.html" title="class in java.lang">RuntimeException</a></code> - 如果在用户提供的组件中发生不可恢复的错误。</span>
<span><a href="../../java/lang/Throwable.html#getCause--">cause</a>将是用户代码中的错误。</span>
</dd>
<dd>
<code><a href="../../java/lang/IllegalStateException.html" title="class in java.lang">IllegalStateException</a></code> - if called more than once 
           </dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>