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

<div class="header">
<div class="subTitle">
     compact3 
   </div>
<div class="subTitle">
     javax.tools 
   </div>
<h2 class="title" title="Interface DocumentationTool">Interface DocumentationTool</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
         All Superinterfaces: 
       </dt>
<dd>
<span><a href="../../javax/tools/OptionChecker.html" title="javax.tools中的接口">OptionChecker</a> ， <a href="../../javax/tools/Tool.html" title="javax.tools中的接口">Tool</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public interface <span class="typeNameLabel">DocumentationTool</span>
extends <a href="../../javax/tools/Tool.html" title="interface in javax.tools">Tool</a>, <a href="../../javax/tools/OptionChecker.html" title="interface in javax.tools">OptionChecker</a></pre>
<div class="block">
        从程序中调用Java编程语言文档工具的接口。 
      </div> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- --> </a> <h3>Nested Class Summary</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption>
<span>Nested Classes</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/tools/DocumentationTool.DocumentationTask.html" title="interface in javax.tools">DocumentationTool.DocumentationTask</a></span></code>
<div class="block">
              表示文档任务的未来的接口。 
            </div> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/tools/DocumentationTool.Location.html" title="enum in javax.tools">DocumentationTool.Location</a></span></code>
<div class="block">
<span>特定于<a href="../../javax/tools/DocumentationTool.html" title="javax.tools中的接口"><code>DocumentationTool</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="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="../../javax/tools/StandardJavaFileManager.html" title="interface in javax.tools">StandardJavaFileManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/tools/DocumentationTool.html#getStandardFileManager-javax.tools.DiagnosticListener-java.util.Locale-java.nio.charset.Charset-">getStandardFileManager</a></span>(<a href="../../javax/tools/DiagnosticListener.html" title="interface in javax.tools">DiagnosticListener</a>&lt;? super <a href="../../javax/tools/JavaFileObject.html" title="interface in javax.tools">JavaFileObject</a>&gt; diagnosticListener, <a href="../../java/util/Locale.html" title="class in java.util">Locale</a> locale, <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a> charset)</code>
<div class="block">
              获取此工具的标准文件管理器实现的新实例。 
            </div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../javax/tools/DocumentationTool.DocumentationTask.html" title="interface in javax.tools">DocumentationTool.DocumentationTask</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/tools/DocumentationTool.html#getTask-java.io.Writer-javax.tools.JavaFileManager-javax.tools.DiagnosticListener-java.lang.Class-java.lang.Iterable-java.lang.Iterable-">getTask</a></span>(<a href="../../java/io/Writer.html" title="class in java.io">Writer</a> out, <a href="../../javax/tools/JavaFileManager.html" title="interface in javax.tools">JavaFileManager</a> fileManager, <a href="../../javax/tools/DiagnosticListener.html" title="interface in javax.tools">DiagnosticListener</a>&lt;? super <a href="../../javax/tools/JavaFileObject.html" title="interface in javax.tools">JavaFileObject</a>&gt; diagnosticListener, <a href="../../java/lang/Class.html" title="class in java.lang">类</a>&lt;?&gt; docletClass, <a href="../../java/lang/Iterable.html" title="interface in java.lang">Iterable</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt; options, <a href="../../java/lang/Iterable.html" title="interface in java.lang">Iterable</a>&lt;? extends <a href="../../javax/tools/JavaFileObject.html" title="interface in javax.tools">JavaFileObject</a>&gt; compilationUnits)</code>
<div class="block">
              使用给定的组件和参数为文档任务创建未来。 
            </div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.tools.Tool">
<!-- --> </a> <h3>Methods inherited from interface javax.tools.<a href="../../javax/tools/Tool.html" title="interface in javax.tools">Tool</a></h3> <code><a href="../../javax/tools/Tool.html#getSourceVersions--">getSourceVersions</a>, <a href="../../javax/tools/Tool.html#run-java.io.InputStream-java.io.OutputStream-java.io.OutputStream-java.lang.String...-">run</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.tools.OptionChecker">
<!-- --> </a> <h3>Methods inherited from interface javax.tools.<a href="../../javax/tools/OptionChecker.html" title="interface in javax.tools">OptionChecker</a></h3> <code><a href="../../javax/tools/OptionChecker.html#isSupportedOption-java.lang.String-">isSupportedOption</a></code></li>
</ul> </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="getTask-java.io.Writer-javax.tools.JavaFileManager-javax.tools.DiagnosticListener-java.lang.Class-java.lang.Iterable-java.lang.Iterable-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getTask</h4> <pre><a href="../../javax/tools/DocumentationTool.DocumentationTask.html" title="interface in javax.tools">DocumentationTool.DocumentationTask</a> getTask(<a href="../../java/io/Writer.html" title="class in java.io">Writer</a> out,
                                            <a href="../../javax/tools/JavaFileManager.html" title="interface in javax.tools">JavaFileManager</a> fileManager,
                                            <a href="../../javax/tools/DiagnosticListener.html" title="interface in javax.tools">DiagnosticListener</a>&lt;? super <a href="../../javax/tools/JavaFileObject.html" title="interface in javax.tools">JavaFileObject</a>&gt; diagnosticListener,
                                            <a href="../../java/lang/Class.html" title="class in java.lang">类</a>&lt;?&gt; docletClass,
                                            <a href="../../java/lang/Iterable.html" title="interface in java.lang">Iterable</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt; options,
                                            <a href="../../java/lang/Iterable.html" title="interface in java.lang">Iterable</a>&lt;? extends <a href="../../javax/tools/JavaFileObject.html" title="interface in javax.tools">JavaFileObject</a>&gt; compilationUnits)</pre>
<div class="block">
<span>使用给定的组件和参数为文档任务创建未来。</span>
<span>该任务可能没有完成，如DocumentationTask界面中所述。</span>
<p> <span>如果提供了文件管理器，它必须能够处理中定义的所有位置<a href="../../javax/tools/DocumentationTool.Location.html" title="javax.tools中的枚举"><code>DocumentationTool.Location</code></a> ，以及<a href="../../javax/tools/StandardLocation.html#SOURCE_PATH"><code>StandardLocation.SOURCE_PATH</code></a> ， <a href="../../javax/tools/StandardLocation.html#CLASS_PATH"><code>StandardLocation.CLASS_PATH</code></a>和<a href="../../javax/tools/StandardLocation.html#PLATFORM_CLASS_PATH"><code>StandardLocation.PLATFORM_CLASS_PATH</code></a> 。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<span><code>out</code> - 一个作者从工具的额外输出;</span>
<span>使用<code>System.err</code>如果<code>null</code></span>
</dd>
<dd>
<span><code>fileManager</code> - 文件管理器;</span>
<span>如果<code>null</code>使用工具的标准文件管理器</span>
</dd>
<dd>
<span><code>diagnosticListener</code> - 诊断听众;</span>
<span>如果<code>null</code>使用工具的默认方法来报告诊断</span>
</dd>
<dd>
<code>docletClass</code> - 提供doclet所需必需方法的类 
           </dd>
<dd>
<code>options</code> - 文档工具选项和doclet选项， 
            <code>null</code>表示无选项 
           </dd>
<dd>
<code>compilationUnits</code> - 汇编单位编译， 
            <code>null</code>表示无编译单位 
           </dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             表示编译的对象 
           </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/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - 如果任何给定的编译单位是其他类型的， 
            <a href="../../javax/tools/JavaFileObject.Kind.html#SOURCE">那么source</a>
</dd>
</dl> </li>
</ul> <a name="getStandardFileManager-javax.tools.DiagnosticListener-java.util.Locale-java.nio.charset.Charset-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getStandardFileManager</h4> <pre><a href="../../javax/tools/StandardJavaFileManager.html" title="interface in javax.tools">StandardJavaFileManager</a> getStandardFileManager(<a href="../../javax/tools/DiagnosticListener.html" title="interface in javax.tools">DiagnosticListener</a>&lt;? super <a href="../../javax/tools/JavaFileObject.html" title="interface in javax.tools">JavaFileObject</a>&gt; diagnosticListener,
                                               <a href="../../java/util/Locale.html" title="class in java.util">Locale</a> locale,
                                               <a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset">Charset</a> charset)</pre>
<div class="block">
<span>获取此工具的标准文件管理器实现的新实例。</span>
<span>文件管理器将使用给定的诊断侦听器来生成任何非致命诊断。</span>
<span>将发出致命错误，并附有适当的例外。</span>
<p> <span>标准文件管理器将在调用<code>flush</code>或<code>close</code>之后被访问时自动重新打开。</span> <span>标准文件管理器必须与其他工具一起使用。</span> </p>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<span><code>diagnosticListener</code> - 用于非致命诊断的诊断侦听器;</span>
<span>如果<code>null</code>使用编译器的默认方法来报告诊断</span>
</dd>
<dd>
<span><code>locale</code> - 格式化诊断时要应用的区域设置;</span>
<span><code>null</code>是指<a href="../../java/util/Locale.html#getDefault--">default locale</a> 。</span>
</dd>
<dd>
<span><code>charset</code> - 用于解码字节的字符集;</span>
<span>如果<code>null</code>使用平台默认</span>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
             标准文件管理器 
           </dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>