index-all.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_242) on Mon Apr 27 18:33:04 UTC 2020 -->
  6. <title>Index (DITA Open Toolkit 3.5.0)</title>
  7. <meta name="date" content="2020-04-27">
  8. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
  9. <script type="text/javascript" src="script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="Index (DITA Open Toolkit 3.5.0)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. </script>
  22. <noscript>
  23. <div>JavaScript is disabled on your browser.</div>
  24. </noscript>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <div class="topNav"><a name="navbar.top">
  27. <!-- -->
  28. </a>
  29. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  30. <a name="navbar.top.firstrow">
  31. <!-- -->
  32. </a>
  33. <ul class="navList" title="Navigation">
  34. <li><a href="overview-summary.html">Overview</a></li>
  35. <li>Package</li>
  36. <li>Class</li>
  37. <li><a href="overview-tree.html">Tree</a></li>
  38. <li><a href="deprecated-list.html">Deprecated</a></li>
  39. <li class="navBarCell1Rev">Index</li>
  40. <li><a href="help-doc.html">Help</a></li>
  41. </ul>
  42. </div>
  43. <div class="subNav">
  44. <ul class="navList">
  45. <li>Prev</li>
  46. <li>Next</li>
  47. </ul>
  48. <ul class="navList">
  49. <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
  50. <li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
  51. </ul>
  52. <ul class="navList" id="allclasses_navbar_top">
  53. <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
  54. </ul>
  55. <div>
  56. <script type="text/javascript"><!--
  57. allClassesLink = document.getElementById("allclasses_navbar_top");
  58. if(window==top) {
  59. allClassesLink.style.display = "block";
  60. }
  61. else {
  62. allClassesLink.style.display = "none";
  63. }
  64. //-->
  65. </script>
  66. </div>
  67. <a name="skip.navbar.top">
  68. <!-- -->
  69. </a></div>
  70. <!-- ========= END OF TOP NAVBAR ========= -->
  71. <div class="contentContainer"><a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a name="I:C">
  72. <!-- -->
  73. </a>
  74. <h2 class="title">C</h2>
  75. <dl>
  76. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#cleanOnFailure-boolean-">cleanOnFailure(boolean)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  77. <dd>
  78. <div class="block">Clean temporary directory when process fails.</div>
  79. </dd>
  80. <dt><a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util"><span class="typeNameLink">Configuration</span></a> - Class in <a href="org/dita/dost/util/package-summary.html">org.dita.dost.util</a></dt>
  81. <dd>
  82. <div class="block">Global configuration object for static configurations.</div>
  83. </dd>
  84. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#configuration">configuration</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  85. <dd>
  86. <div class="block">Immutable configuration properties.</div>
  87. </dd>
  88. <dt><a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util"><span class="typeNameLink">Configuration.Mode</span></a> - Enum in <a href="org/dita/dost/util/package-summary.html">org.dita.dost.util</a></dt>
  89. <dd>
  90. <div class="block">Processing mode</div>
  91. </dd>
  92. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#createDebugLog-boolean-">createDebugLog(boolean)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  93. <dd>
  94. <div class="block">Write a debug log to temporary directory.</div>
  95. </dd>
  96. </dl>
  97. <a name="I:D">
  98. <!-- -->
  99. </a>
  100. <h2 class="title">D</h2>
  101. <dl>
  102. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#DEBUG">DEBUG</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  103. <dd>
  104. <div class="block">Debug mode to aid in development, not intended for end users.</div>
  105. </dd>
  106. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#ditaFormat">ditaFormat</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  107. <dd>&nbsp;</dd>
  108. <dt><a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception"><span class="typeNameLink">DITAOTException</span></a> - Exception in <a href="org/dita/dost/exception/package-summary.html">org.dita.dost.exception</a></dt>
  109. <dd>
  110. <div class="block">Exception class for DITAOT, used to handle exceptions in Java modules.</div>
  111. </dd>
  112. <dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException--">DITAOTException()</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
  113. <dd>
  114. <div class="block">Constructs a new DITAOTException with <code>null</code>
  115. as its detail message.</div>
  116. </dd>
  117. <dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-">DITAOTException(String)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
  118. <dd>
  119. <div class="block">Constructs a new exception with the specified detail message.</div>
  120. </dd>
  121. <dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.Throwable-">DITAOTException(Throwable)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
  122. <dd>
  123. <div class="block">Constructs a new exception with the specified detail cause.</div>
  124. </dd>
  125. <dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-java.lang.Throwable-">DITAOTException(String, Throwable)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
  126. <dd>
  127. <div class="block">Constructs a new exception with the specified detail message and
  128. cause.</div>
  129. </dd>
  130. <dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-net.sf.saxon.trans.UncheckedXPathException-">DITAOTException(UncheckedXPathException)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
  131. <dd>
  132. <div class="block">Constructs a new exception with cause, using location information from a root <code>XPathException</code></div>
  133. </dd>
  134. <dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-java.lang.String-net.sf.saxon.trans.UncheckedXPathException-">DITAOTException(String, UncheckedXPathException)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
  135. <dd>
  136. <div class="block">Constructs a new exception with the specified detail message and
  137. cause, using location information from a root <code>XPathException</code></div>
  138. </dd>
  139. <dt><span class="memberNameLink"><a href="org/dita/dost/exception/DITAOTException.html#DITAOTException-MessageBean-java.lang.Throwable-java.lang.String-">DITAOTException(MessageBean, Throwable, String)</a></span> - Constructor for exception org.dita.dost.exception.<a href="org/dita/dost/exception/DITAOTException.html" title="class in org.dita.dost.exception">DITAOTException</a></dt>
  140. <dd>
  141. <div class="block">Constructs a new exception with the detailed messagebean and
  142. cause.</div>
  143. </dd>
  144. </dl>
  145. <a name="I:N">
  146. <!-- -->
  147. </a>
  148. <h2 class="title">N</h2>
  149. <dl>
  150. <dt><span class="memberNameLink"><a href="org/dita/dost/ProcessorFactory.html#newInstance-java.io.File-">newInstance(File)</a></span> - Static method in class org.dita.dost.<a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></dt>
  151. <dd>
  152. <div class="block">Obtain a new instance of a ProcessorFactory.</div>
  153. </dd>
  154. <dt><span class="memberNameLink"><a href="org/dita/dost/ProcessorFactory.html#newProcessor-java.lang.String-">newProcessor(String)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></dt>
  155. <dd>
  156. <div class="block">Create new Processor to run DITA-OT</div>
  157. </dd>
  158. </dl>
  159. <a name="I:O">
  160. <!-- -->
  161. </a>
  162. <h2 class="title">O</h2>
  163. <dl>
  164. <dt><a href="org/dita/dost/package-summary.html">org.dita.dost</a> - package org.dita.dost</dt>
  165. <dd>&nbsp;</dd>
  166. <dt><a href="org/dita/dost/exception/package-summary.html">org.dita.dost.exception</a> - package org.dita.dost.exception</dt>
  167. <dd>&nbsp;</dd>
  168. <dt><a href="org/dita/dost/util/package-summary.html">org.dita.dost.util</a> - package org.dita.dost.util</dt>
  169. <dd>&nbsp;</dd>
  170. </dl>
  171. <a name="I:P">
  172. <!-- -->
  173. </a>
  174. <h2 class="title">P</h2>
  175. <dl>
  176. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#parserFeatures">parserFeatures</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  177. <dd>&nbsp;</dd>
  178. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#parserMap">parserMap</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  179. <dd>&nbsp;</dd>
  180. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#pluginResourceDirs">pluginResourceDirs</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  181. <dd>
  182. <div class="block">Map of plug-in resource directories.</div>
  183. </dd>
  184. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#printTranstype">printTranstype</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  185. <dd>
  186. <div class="block">List of print-oriented transtypes.</div>
  187. </dd>
  188. <dt><a href="org/dita/dost/Processor.html" title="class in org.dita.dost"><span class="typeNameLink">Processor</span></a> - Class in <a href="org/dita/dost/package-summary.html">org.dita.dost</a></dt>
  189. <dd>
  190. <div class="block">DITA-OT processer.</div>
  191. </dd>
  192. <dt><a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost"><span class="typeNameLink">ProcessorFactory</span></a> - Class in <a href="org/dita/dost/package-summary.html">org.dita.dost</a></dt>
  193. <dd>
  194. <div class="block">DITA-OT processer factory.</div>
  195. </dd>
  196. </dl>
  197. <a name="I:R">
  198. <!-- -->
  199. </a>
  200. <h2 class="title">R</h2>
  201. <dl>
  202. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#run--">run()</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  203. <dd>
  204. <div class="block">Run process</div>
  205. </dd>
  206. </dl>
  207. <a name="I:S">
  208. <!-- -->
  209. </a>
  210. <h2 class="title">S</h2>
  211. <dl>
  212. <dt><span class="memberNameLink"><a href="org/dita/dost/ProcessorFactory.html#setBaseTempDir-java.io.File-">setBaseTempDir(File)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/ProcessorFactory.html" title="class in org.dita.dost">ProcessorFactory</a></dt>
  213. <dd>
  214. <div class="block">Set base directory for temporary directories.</div>
  215. </dd>
  216. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setInput-java.io.File-">setInput(File)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  217. <dd>
  218. <div class="block">Set input document.</div>
  219. </dd>
  220. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setInput-java.net.URI-">setInput(URI)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  221. <dd>
  222. <div class="block">Set input document.</div>
  223. </dd>
  224. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setLogger-org.slf4j.Logger-">setLogger(Logger)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  225. <dd>
  226. <div class="block">Set process logger</div>
  227. </dd>
  228. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setMode-org.dita.dost.util.Configuration.Mode-">setMode(Configuration.Mode)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  229. <dd>
  230. <div class="block">Set error recovery mode.</div>
  231. </dd>
  232. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setOutputDir-java.io.File-">setOutputDir(File)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  233. <dd>
  234. <div class="block">Set output directory.</div>
  235. </dd>
  236. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setOutputDir-java.net.URI-">setOutputDir(URI)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  237. <dd>
  238. <div class="block">Set output directory.</div>
  239. </dd>
  240. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setProperties-java.util.Map-">setProperties(Map&lt;String, String&gt;)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  241. <dd>
  242. <div class="block">Set properties.</div>
  243. </dd>
  244. <dt><span class="memberNameLink"><a href="org/dita/dost/Processor.html#setProperty-java.lang.String-java.lang.String-">setProperty(String, String)</a></span> - Method in class org.dita.dost.<a href="org/dita/dost/Processor.html" title="class in org.dita.dost">Processor</a></dt>
  245. <dd>
  246. <div class="block">Set property.</div>
  247. </dd>
  248. </dl>
  249. <a name="I:T">
  250. <!-- -->
  251. </a>
  252. <h2 class="title">T</h2>
  253. <dl>
  254. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.html#transtypes">transtypes</a></span> - Static variable in class org.dita.dost.util.<a href="org/dita/dost/util/Configuration.html" title="class in org.dita.dost.util">Configuration</a></dt>
  255. <dd>
  256. <div class="block">List of transtypes.</div>
  257. </dd>
  258. </dl>
  259. <a name="I:V">
  260. <!-- -->
  261. </a>
  262. <h2 class="title">V</h2>
  263. <dl>
  264. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.Mode.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum org.dita.dost.util.<a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></dt>
  265. <dd>
  266. <div class="block">Returns the enum constant of this type with the specified name.</div>
  267. </dd>
  268. <dt><span class="memberNameLink"><a href="org/dita/dost/util/Configuration.Mode.html#values--">values()</a></span> - Static method in enum org.dita.dost.util.<a href="org/dita/dost/util/Configuration.Mode.html" title="enum in org.dita.dost.util">Configuration.Mode</a></dt>
  269. <dd>
  270. <div class="block">Returns an array containing the constants of this enum type, in
  271. the order they are declared.</div>
  272. </dd>
  273. </dl>
  274. <a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;</div>
  275. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  276. <div class="bottomNav"><a name="navbar.bottom">
  277. <!-- -->
  278. </a>
  279. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  280. <a name="navbar.bottom.firstrow">
  281. <!-- -->
  282. </a>
  283. <ul class="navList" title="Navigation">
  284. <li><a href="overview-summary.html">Overview</a></li>
  285. <li>Package</li>
  286. <li>Class</li>
  287. <li><a href="overview-tree.html">Tree</a></li>
  288. <li><a href="deprecated-list.html">Deprecated</a></li>
  289. <li class="navBarCell1Rev">Index</li>
  290. <li><a href="help-doc.html">Help</a></li>
  291. </ul>
  292. </div>
  293. <div class="subNav">
  294. <ul class="navList">
  295. <li>Prev</li>
  296. <li>Next</li>
  297. </ul>
  298. <ul class="navList">
  299. <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
  300. <li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
  301. </ul>
  302. <ul class="navList" id="allclasses_navbar_bottom">
  303. <li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
  304. </ul>
  305. <div>
  306. <script type="text/javascript"><!--
  307. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  308. if(window==top) {
  309. allClassesLink.style.display = "block";
  310. }
  311. else {
  312. allClassesLink.style.display = "none";
  313. }
  314. //-->
  315. </script>
  316. </div>
  317. <a name="skip.navbar.bottom">
  318. <!-- -->
  319. </a></div>
  320. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  321. </body>
  322. </html>