XmlStreamWriter.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  7. <title>XmlStreamWriter (Apache Commons IO 2.6 API)</title>
  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="XmlStreamWriter (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/XmlStreamWriter.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../../index-all.html">Index</a></li>
  47. <li><a href="../../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../../org/apache/commons/io/output/WriterOutputStream.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li>Next&nbsp;Class</li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../../index.html?org/apache/commons/io/output/XmlStreamWriter.html" target="_top">Frames</a></li>
  57. <li><a href="XmlStreamWriter.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#fields.inherited.from.class.java.io.Writer">Field</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io.output</div>
  96. <h2 title="Class XmlStreamWriter" class="title">Class XmlStreamWriter</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">java.io.Writer</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.apache.commons.io.output.XmlStreamWriter</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <span class="typeNameLabel">XmlStreamWriter</span>
  122. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></pre>
  123. <div class="block">Character stream that handles all the necessary Voodoo to figure out the
  124. charset encoding of the XML document written to the stream.</div>
  125. <dl>
  126. <dt><span class="simpleTagLabel">Since:</span></dt>
  127. <dd>2.0</dd>
  128. <dt><span class="seeLabel">See Also:</span></dt>
  129. <dd><a href="../../../../../org/apache/commons/io/input/XmlStreamReader.html" title="class in org.apache.commons.io.input"><code>XmlStreamReader</code></a></dd>
  130. </dl>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- =========== FIELD SUMMARY =========== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="field.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Field Summary</h3>
  143. <ul class="blockList">
  144. <li class="blockList"><a name="fields.inherited.from.class.java.io.Writer">
  145. <!-- -->
  146. </a>
  147. <h3>Fields inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></h3>
  148. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#lock" title="class or interface in java.io">lock</a></code></li>
  149. </ul>
  150. </li>
  151. </ul>
  152. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  153. <ul class="blockList">
  154. <li class="blockList"><a name="constructor.summary">
  155. <!-- -->
  156. </a>
  157. <h3>Constructor Summary</h3>
  158. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  159. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  160. <tr>
  161. <th class="colOne" scope="col">Constructor and Description</th>
  162. </tr>
  163. <tr class="altColor">
  164. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#XmlStreamWriter-java.io.File-">XmlStreamWriter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)</code>
  165. <div class="block">Constructs a new XML stream writer for the specified file
  166. with a default encoding of UTF-8.</div>
  167. </td>
  168. </tr>
  169. <tr class="rowColor">
  170. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#XmlStreamWriter-java.io.File-java.lang.String-">XmlStreamWriter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
  171. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultEncoding)</code>
  172. <div class="block">Constructs a new XML stream writer for the specified file
  173. with the specified default encoding.</div>
  174. </td>
  175. </tr>
  176. <tr class="altColor">
  177. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#XmlStreamWriter-java.io.OutputStream-">XmlStreamWriter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out)</code>
  178. <div class="block">Constructs a new XML stream writer for the specified output stream
  179. with a default encoding of UTF-8.</div>
  180. </td>
  181. </tr>
  182. <tr class="rowColor">
  183. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#XmlStreamWriter-java.io.OutputStream-java.lang.String-">XmlStreamWriter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out,
  184. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultEncoding)</code>
  185. <div class="block">Constructs a new XML stream writer for the specified output stream
  186. with the specified default encoding.</div>
  187. </td>
  188. </tr>
  189. </table>
  190. </li>
  191. </ul>
  192. <!-- ========== METHOD SUMMARY =========== -->
  193. <ul class="blockList">
  194. <li class="blockList"><a name="method.summary">
  195. <!-- -->
  196. </a>
  197. <h3>Method Summary</h3>
  198. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  199. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  200. <tr>
  201. <th class="colFirst" scope="col">Modifier and Type</th>
  202. <th class="colLast" scope="col">Method and Description</th>
  203. </tr>
  204. <tr id="i0" class="altColor">
  205. <td class="colFirst"><code>void</code></td>
  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#close--">close</a></span>()</code>
  207. <div class="block">Closes the underlying writer.</div>
  208. </td>
  209. </tr>
  210. <tr id="i1" class="rowColor">
  211. <td class="colFirst"><code>void</code></td>
  212. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#flush--">flush</a></span>()</code>
  213. <div class="block">Flushes the underlying writer.</div>
  214. </td>
  215. </tr>
  216. <tr id="i2" class="altColor">
  217. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  218. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#getDefaultEncoding--">getDefaultEncoding</a></span>()</code>
  219. <div class="block">Returns the default encoding.</div>
  220. </td>
  221. </tr>
  222. <tr id="i3" class="rowColor">
  223. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  224. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#getEncoding--">getEncoding</a></span>()</code>
  225. <div class="block">Returns the detected encoding.</div>
  226. </td>
  227. </tr>
  228. <tr id="i4" class="altColor">
  229. <td class="colFirst"><code>void</code></td>
  230. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/XmlStreamWriter.html#write-char:A-int-int-">write</a></span>(char[]&nbsp;cbuf,
  231. int&nbsp;off,
  232. int&nbsp;len)</code>
  233. <div class="block">Writes the characters to the underlying writer, detecting encoding.</div>
  234. </td>
  235. </tr>
  236. </table>
  237. <ul class="blockList">
  238. <li class="blockList"><a name="methods.inherited.from.class.java.io.Writer">
  239. <!-- -->
  240. </a>
  241. <h3>Methods inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></h3>
  242. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#append-char-" title="class or interface in java.io">append</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#append-java.lang.CharSequence-" title="class or interface in java.io">append</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#append-java.lang.CharSequence-int-int-" title="class or interface in java.io">append</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-char:A-" title="class or interface in java.io">write</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-int-" title="class or interface in java.io">write</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-java.lang.String-" title="class or interface in java.io">write</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-java.lang.String-int-int-" title="class or interface in java.io">write</a></code></li>
  243. </ul>
  244. <ul class="blockList">
  245. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  246. <!-- -->
  247. </a>
  248. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  249. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  250. </ul>
  251. </li>
  252. </ul>
  253. </li>
  254. </ul>
  255. </div>
  256. <div class="details">
  257. <ul class="blockList">
  258. <li class="blockList">
  259. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  260. <ul class="blockList">
  261. <li class="blockList"><a name="constructor.detail">
  262. <!-- -->
  263. </a>
  264. <h3>Constructor Detail</h3>
  265. <a name="XmlStreamWriter-java.io.OutputStream-">
  266. <!-- -->
  267. </a>
  268. <ul class="blockList">
  269. <li class="blockList">
  270. <h4>XmlStreamWriter</h4>
  271. <pre>public&nbsp;XmlStreamWriter(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out)</pre>
  272. <div class="block">Constructs a new XML stream writer for the specified output stream
  273. with a default encoding of UTF-8.</div>
  274. <dl>
  275. <dt><span class="paramLabel">Parameters:</span></dt>
  276. <dd><code>out</code> - The output stream</dd>
  277. </dl>
  278. </li>
  279. </ul>
  280. <a name="XmlStreamWriter-java.io.OutputStream-java.lang.String-">
  281. <!-- -->
  282. </a>
  283. <ul class="blockList">
  284. <li class="blockList">
  285. <h4>XmlStreamWriter</h4>
  286. <pre>public&nbsp;XmlStreamWriter(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out,
  287. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultEncoding)</pre>
  288. <div class="block">Constructs a new XML stream writer for the specified output stream
  289. with the specified default encoding.</div>
  290. <dl>
  291. <dt><span class="paramLabel">Parameters:</span></dt>
  292. <dd><code>out</code> - The output stream</dd>
  293. <dd><code>defaultEncoding</code> - The default encoding if not encoding could be detected</dd>
  294. </dl>
  295. </li>
  296. </ul>
  297. <a name="XmlStreamWriter-java.io.File-">
  298. <!-- -->
  299. </a>
  300. <ul class="blockList">
  301. <li class="blockList">
  302. <h4>XmlStreamWriter</h4>
  303. <pre>public&nbsp;XmlStreamWriter(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)
  304. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></pre>
  305. <div class="block">Constructs a new XML stream writer for the specified file
  306. with a default encoding of UTF-8.</div>
  307. <dl>
  308. <dt><span class="paramLabel">Parameters:</span></dt>
  309. <dd><code>file</code> - The file to write to</dd>
  310. <dt><span class="throwsLabel">Throws:</span></dt>
  311. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if there is an error creating or
  312. opening the file</dd>
  313. </dl>
  314. </li>
  315. </ul>
  316. <a name="XmlStreamWriter-java.io.File-java.lang.String-">
  317. <!-- -->
  318. </a>
  319. <ul class="blockListLast">
  320. <li class="blockList">
  321. <h4>XmlStreamWriter</h4>
  322. <pre>public&nbsp;XmlStreamWriter(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
  323. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultEncoding)
  324. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></pre>
  325. <div class="block">Constructs a new XML stream writer for the specified file
  326. with the specified default encoding.</div>
  327. <dl>
  328. <dt><span class="paramLabel">Parameters:</span></dt>
  329. <dd><code>file</code> - The file to write to</dd>
  330. <dd><code>defaultEncoding</code> - The default encoding if not encoding could be detected</dd>
  331. <dt><span class="throwsLabel">Throws:</span></dt>
  332. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if there is an error creating or
  333. opening the file</dd>
  334. </dl>
  335. </li>
  336. </ul>
  337. </li>
  338. </ul>
  339. <!-- ============ METHOD DETAIL ========== -->
  340. <ul class="blockList">
  341. <li class="blockList"><a name="method.detail">
  342. <!-- -->
  343. </a>
  344. <h3>Method Detail</h3>
  345. <a name="getEncoding--">
  346. <!-- -->
  347. </a>
  348. <ul class="blockList">
  349. <li class="blockList">
  350. <h4>getEncoding</h4>
  351. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getEncoding()</pre>
  352. <div class="block">Returns the detected encoding.</div>
  353. <dl>
  354. <dt><span class="returnLabel">Returns:</span></dt>
  355. <dd>the detected encoding</dd>
  356. </dl>
  357. </li>
  358. </ul>
  359. <a name="getDefaultEncoding--">
  360. <!-- -->
  361. </a>
  362. <ul class="blockList">
  363. <li class="blockList">
  364. <h4>getDefaultEncoding</h4>
  365. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDefaultEncoding()</pre>
  366. <div class="block">Returns the default encoding.</div>
  367. <dl>
  368. <dt><span class="returnLabel">Returns:</span></dt>
  369. <dd>the default encoding</dd>
  370. </dl>
  371. </li>
  372. </ul>
  373. <a name="close--">
  374. <!-- -->
  375. </a>
  376. <ul class="blockList">
  377. <li class="blockList">
  378. <h4>close</h4>
  379. <pre>public&nbsp;void&nbsp;close()
  380. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  381. <div class="block">Closes the underlying writer.</div>
  382. <dl>
  383. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  384. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
  385. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  386. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
  387. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  388. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></dd>
  389. <dt><span class="throwsLabel">Throws:</span></dt>
  390. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an error occurs closing the underlying writer</dd>
  391. </dl>
  392. </li>
  393. </ul>
  394. <a name="flush--">
  395. <!-- -->
  396. </a>
  397. <ul class="blockList">
  398. <li class="blockList">
  399. <h4>flush</h4>
  400. <pre>public&nbsp;void&nbsp;flush()
  401. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  402. <div class="block">Flushes the underlying writer.</div>
  403. <dl>
  404. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  405. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true#flush--" title="class or interface in java.io">flush</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a></code></dd>
  406. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  407. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#flush--" title="class or interface in java.io">flush</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></dd>
  408. <dt><span class="throwsLabel">Throws:</span></dt>
  409. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an error occurs flushing the underlying writer</dd>
  410. </dl>
  411. </li>
  412. </ul>
  413. <a name="write-char:A-int-int-">
  414. <!-- -->
  415. </a>
  416. <ul class="blockListLast">
  417. <li class="blockList">
  418. <h4>write</h4>
  419. <pre>public&nbsp;void&nbsp;write(char[]&nbsp;cbuf,
  420. int&nbsp;off,
  421. int&nbsp;len)
  422. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  423. <div class="block">Writes the characters to the underlying writer, detecting encoding.</div>
  424. <dl>
  425. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  426. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-char:A-int-int-" title="class or interface in java.io">write</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></dd>
  427. <dt><span class="paramLabel">Parameters:</span></dt>
  428. <dd><code>cbuf</code> - the buffer to write the characters from</dd>
  429. <dd><code>off</code> - The start offset</dd>
  430. <dd><code>len</code> - The number of characters to write</dd>
  431. <dt><span class="throwsLabel">Throws:</span></dt>
  432. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an error occurs detecting the encoding</dd>
  433. </dl>
  434. </li>
  435. </ul>
  436. </li>
  437. </ul>
  438. </li>
  439. </ul>
  440. </div>
  441. </div>
  442. <!-- ========= END OF CLASS DATA ========= -->
  443. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  444. <div class="bottomNav"><a name="navbar.bottom">
  445. <!-- -->
  446. </a>
  447. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  448. <a name="navbar.bottom.firstrow">
  449. <!-- -->
  450. </a>
  451. <ul class="navList" title="Navigation">
  452. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  453. <li><a href="package-summary.html">Package</a></li>
  454. <li class="navBarCell1Rev">Class</li>
  455. <li><a href="class-use/XmlStreamWriter.html">Use</a></li>
  456. <li><a href="package-tree.html">Tree</a></li>
  457. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  458. <li><a href="../../../../../index-all.html">Index</a></li>
  459. <li><a href="../../../../../help-doc.html">Help</a></li>
  460. </ul>
  461. </div>
  462. <div class="subNav">
  463. <ul class="navList">
  464. <li><a href="../../../../../org/apache/commons/io/output/WriterOutputStream.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  465. <li>Next&nbsp;Class</li>
  466. </ul>
  467. <ul class="navList">
  468. <li><a href="../../../../../index.html?org/apache/commons/io/output/XmlStreamWriter.html" target="_top">Frames</a></li>
  469. <li><a href="XmlStreamWriter.html" target="_top">No&nbsp;Frames</a></li>
  470. </ul>
  471. <ul class="navList" id="allclasses_navbar_bottom">
  472. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  473. </ul>
  474. <div>
  475. <script type="text/javascript"><!--
  476. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  477. if(window==top) {
  478. allClassesLink.style.display = "block";
  479. }
  480. else {
  481. allClassesLink.style.display = "none";
  482. }
  483. //-->
  484. </script>
  485. </div>
  486. <div>
  487. <ul class="subNavList">
  488. <li>Summary:&nbsp;</li>
  489. <li>Nested&nbsp;|&nbsp;</li>
  490. <li><a href="#fields.inherited.from.class.java.io.Writer">Field</a>&nbsp;|&nbsp;</li>
  491. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  492. <li><a href="#method.summary">Method</a></li>
  493. </ul>
  494. <ul class="subNavList">
  495. <li>Detail:&nbsp;</li>
  496. <li>Field&nbsp;|&nbsp;</li>
  497. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  498. <li><a href="#method.detail">Method</a></li>
  499. </ul>
  500. </div>
  501. <a name="skip.navbar.bottom">
  502. <!-- -->
  503. </a></div>
  504. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  505. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  506. </body>
  507. </html>