HexDump.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  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>HexDump (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="HexDump (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/HexDump.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/FileUtils.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/apache/commons/io/HexDump.html" target="_top">Frames</a></li>
  57. <li><a href="HexDump.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="#field.summary">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><a href="#field.detail">Field</a>&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</div>
  96. <h2 title="Class HexDump" class="title">Class HexDump</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>org.apache.commons.io.HexDump</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public class <span class="typeNameLabel">HexDump</span>
  113. extends <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></pre>
  114. <div class="block">Dumps data in hexadecimal format.
  115. <p>
  116. Provides a single function to take an array of bytes and display it
  117. in hexadecimal form.
  118. <p>
  119. Origin of code: POI.</div>
  120. </li>
  121. </ul>
  122. </div>
  123. <div class="summary">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <!-- =========== FIELD SUMMARY =========== -->
  127. <ul class="blockList">
  128. <li class="blockList"><a name="field.summary">
  129. <!-- -->
  130. </a>
  131. <h3>Field Summary</h3>
  132. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  133. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  134. <tr>
  135. <th class="colFirst" scope="col">Modifier and Type</th>
  136. <th class="colLast" scope="col">Field and Description</th>
  137. </tr>
  138. <tr class="altColor">
  139. <td class="colFirst"><code>static <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>
  140. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/HexDump.html#EOL">EOL</a></span></code>
  141. <div class="block">The line-separator (initializes to "line.separator" system property.</div>
  142. </td>
  143. </tr>
  144. </table>
  145. </li>
  146. </ul>
  147. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  148. <ul class="blockList">
  149. <li class="blockList"><a name="constructor.summary">
  150. <!-- -->
  151. </a>
  152. <h3>Constructor Summary</h3>
  153. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  154. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  155. <tr>
  156. <th class="colOne" scope="col">Constructor and Description</th>
  157. </tr>
  158. <tr class="altColor">
  159. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/HexDump.html#HexDump--">HexDump</a></span>()</code>
  160. <div class="block">Instances should NOT be constructed in standard programming.</div>
  161. </td>
  162. </tr>
  163. </table>
  164. </li>
  165. </ul>
  166. <!-- ========== METHOD SUMMARY =========== -->
  167. <ul class="blockList">
  168. <li class="blockList"><a name="method.summary">
  169. <!-- -->
  170. </a>
  171. <h3>Method Summary</h3>
  172. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  173. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>
  174. <tr>
  175. <th class="colFirst" scope="col">Modifier and Type</th>
  176. <th class="colLast" scope="col">Method and Description</th>
  177. </tr>
  178. <tr id="i0" class="altColor">
  179. <td class="colFirst"><code>static void</code></td>
  180. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/HexDump.html#dump-byte:A-long-java.io.OutputStream-int-">dump</a></span>(byte[]&nbsp;data,
  181. long&nbsp;offset,
  182. <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;stream,
  183. int&nbsp;index)</code>
  184. <div class="block">Dump an array of bytes to an OutputStream.</div>
  185. </td>
  186. </tr>
  187. </table>
  188. <ul class="blockList">
  189. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  190. <!-- -->
  191. </a>
  192. <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>
  193. <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>
  194. </ul>
  195. </li>
  196. </ul>
  197. </li>
  198. </ul>
  199. </div>
  200. <div class="details">
  201. <ul class="blockList">
  202. <li class="blockList">
  203. <!-- ============ FIELD DETAIL =========== -->
  204. <ul class="blockList">
  205. <li class="blockList"><a name="field.detail">
  206. <!-- -->
  207. </a>
  208. <h3>Field Detail</h3>
  209. <a name="EOL">
  210. <!-- -->
  211. </a>
  212. <ul class="blockListLast">
  213. <li class="blockList">
  214. <h4>EOL</h4>
  215. <pre>public static final&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> EOL</pre>
  216. <div class="block">The line-separator (initializes to "line.separator" system property.</div>
  217. </li>
  218. </ul>
  219. </li>
  220. </ul>
  221. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  222. <ul class="blockList">
  223. <li class="blockList"><a name="constructor.detail">
  224. <!-- -->
  225. </a>
  226. <h3>Constructor Detail</h3>
  227. <a name="HexDump--">
  228. <!-- -->
  229. </a>
  230. <ul class="blockListLast">
  231. <li class="blockList">
  232. <h4>HexDump</h4>
  233. <pre>public&nbsp;HexDump()</pre>
  234. <div class="block">Instances should NOT be constructed in standard programming.</div>
  235. </li>
  236. </ul>
  237. </li>
  238. </ul>
  239. <!-- ============ METHOD DETAIL ========== -->
  240. <ul class="blockList">
  241. <li class="blockList"><a name="method.detail">
  242. <!-- -->
  243. </a>
  244. <h3>Method Detail</h3>
  245. <a name="dump-byte:A-long-java.io.OutputStream-int-">
  246. <!-- -->
  247. </a>
  248. <ul class="blockListLast">
  249. <li class="blockList">
  250. <h4>dump</h4>
  251. <pre>public static&nbsp;void&nbsp;dump(byte[]&nbsp;data,
  252. long&nbsp;offset,
  253. <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;stream,
  254. int&nbsp;index)
  255. 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>,
  256. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a>,
  257. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
  258. <div class="block">Dump an array of bytes to an OutputStream. The output is formatted
  259. for human inspection, with a hexadecimal offset followed by the
  260. hexadecimal values of the next 16 bytes of data and the printable ASCII
  261. characters (if any) that those bytes represent printed per each line
  262. of output.
  263. <p>
  264. The offset argument specifies the start offset of the data array
  265. within a larger entity like a file or an incoming stream. For example,
  266. if the data array contains the third kibibyte of a file, then the
  267. offset argument should be set to 2048. The offset value printed
  268. at the beginning of each line indicates where in that larger entity
  269. the first byte on that line is located.
  270. <p>
  271. All bytes between the given index (inclusive) and the end of the
  272. data array are dumped.</div>
  273. <dl>
  274. <dt><span class="paramLabel">Parameters:</span></dt>
  275. <dd><code>data</code> - the byte array to be dumped</dd>
  276. <dd><code>offset</code> - offset of the byte array within a larger entity</dd>
  277. <dd><code>stream</code> - the OutputStream to which the data is to be
  278. written</dd>
  279. <dd><code>index</code> - initial index into the byte array</dd>
  280. <dt><span class="throwsLabel">Throws:</span></dt>
  281. <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> - is thrown if anything goes wrong writing
  282. the data to stream</dd>
  283. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - if the index is
  284. outside the data array's bounds</dd>
  285. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the output stream is null</dd>
  286. </dl>
  287. </li>
  288. </ul>
  289. </li>
  290. </ul>
  291. </li>
  292. </ul>
  293. </div>
  294. </div>
  295. <!-- ========= END OF CLASS DATA ========= -->
  296. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  297. <div class="bottomNav"><a name="navbar.bottom">
  298. <!-- -->
  299. </a>
  300. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  301. <a name="navbar.bottom.firstrow">
  302. <!-- -->
  303. </a>
  304. <ul class="navList" title="Navigation">
  305. <li><a href="../../../../overview-summary.html">Overview</a></li>
  306. <li><a href="package-summary.html">Package</a></li>
  307. <li class="navBarCell1Rev">Class</li>
  308. <li><a href="class-use/HexDump.html">Use</a></li>
  309. <li><a href="package-tree.html">Tree</a></li>
  310. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  311. <li><a href="../../../../index-all.html">Index</a></li>
  312. <li><a href="../../../../help-doc.html">Help</a></li>
  313. </ul>
  314. </div>
  315. <div class="subNav">
  316. <ul class="navList">
  317. <li><a href="../../../../org/apache/commons/io/FileUtils.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  318. <li><a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  319. </ul>
  320. <ul class="navList">
  321. <li><a href="../../../../index.html?org/apache/commons/io/HexDump.html" target="_top">Frames</a></li>
  322. <li><a href="HexDump.html" target="_top">No&nbsp;Frames</a></li>
  323. </ul>
  324. <ul class="navList" id="allclasses_navbar_bottom">
  325. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  326. </ul>
  327. <div>
  328. <script type="text/javascript"><!--
  329. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  330. if(window==top) {
  331. allClassesLink.style.display = "block";
  332. }
  333. else {
  334. allClassesLink.style.display = "none";
  335. }
  336. //-->
  337. </script>
  338. </div>
  339. <div>
  340. <ul class="subNavList">
  341. <li>Summary:&nbsp;</li>
  342. <li>Nested&nbsp;|&nbsp;</li>
  343. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  344. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  345. <li><a href="#method.summary">Method</a></li>
  346. </ul>
  347. <ul class="subNavList">
  348. <li>Detail:&nbsp;</li>
  349. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  350. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  351. <li><a href="#method.detail">Method</a></li>
  352. </ul>
  353. </div>
  354. <a name="skip.navbar.bottom">
  355. <!-- -->
  356. </a></div>
  357. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  358. <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>
  359. </body>
  360. </html>