MessageDigestCalculatingInputStream.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  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>MessageDigestCalculatingInputStream (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="MessageDigestCalculatingInputStream (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":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/MessageDigestCalculatingInputStream.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/input/InfiniteCircularInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver.html" title="class in org.apache.commons.io.input"><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/input/MessageDigestCalculatingInputStream.html" target="_top">Frames</a></li>
  57. <li><a href="MessageDigestCalculatingInputStream.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  78. <li><a href="#fields.inherited.from.class.java.io.FilterInputStream">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.input</div>
  96. <h2 title="Class MessageDigestCalculatingInputStream" class="title">Class MessageDigestCalculatingInputStream</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/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">java.io.FilterInputStream</a></li>
  107. <li>
  108. <ul class="inheritance">
  109. <li><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">org.apache.commons.io.input.ProxyInputStream</a></li>
  110. <li>
  111. <ul class="inheritance">
  112. <li><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input">org.apache.commons.io.input.ObservableInputStream</a></li>
  113. <li>
  114. <ul class="inheritance">
  115. <li>org.apache.commons.io.input.MessageDigestCalculatingInputStream</li>
  116. </ul>
  117. </li>
  118. </ul>
  119. </li>
  120. </ul>
  121. </li>
  122. </ul>
  123. </li>
  124. </ul>
  125. </li>
  126. </ul>
  127. <div class="description">
  128. <ul class="blockList">
  129. <li class="blockList">
  130. <dl>
  131. <dt>All Implemented Interfaces:</dt>
  132. <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/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
  133. </dl>
  134. <hr>
  135. <br>
  136. <pre>public class <span class="typeNameLabel">MessageDigestCalculatingInputStream</span>
  137. extends <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input">ObservableInputStream</a></pre>
  138. <div class="block">This class is an example for using an <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream</code></a>. It
  139. creates its own <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream.Observer</code></a>,
  140. which calculates a checksum using a MessageDigest, for example an MD5 sum.
  141. <em>Note</em>: Neither <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream</code></a>, nor <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a>,
  142. are thread safe. So is <a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html" title="class in org.apache.commons.io.input"><code>MessageDigestCalculatingInputStream</code></a>.</div>
  143. </li>
  144. </ul>
  145. </div>
  146. <div class="summary">
  147. <ul class="blockList">
  148. <li class="blockList">
  149. <!-- ======== NESTED CLASS SUMMARY ======== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="nested.class.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Nested Class Summary</h3>
  155. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
  156. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  157. <tr>
  158. <th class="colFirst" scope="col">Modifier and Type</th>
  159. <th class="colLast" scope="col">Class and Description</th>
  160. </tr>
  161. <tr class="altColor">
  162. <td class="colFirst"><code>static class&nbsp;</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver.html" title="class in org.apache.commons.io.input">MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver</a></span></code>
  164. <div class="block">Maintains the message digest.</div>
  165. </td>
  166. </tr>
  167. </table>
  168. <ul class="blockList">
  169. <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.commons.io.input.ObservableInputStream">
  170. <!-- -->
  171. </a>
  172. <h3>Nested classes/interfaces inherited from class&nbsp;org.apache.commons.io.input.<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input">ObservableInputStream</a></h3>
  173. <code><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a></code></li>
  174. </ul>
  175. </li>
  176. </ul>
  177. <!-- =========== FIELD SUMMARY =========== -->
  178. <ul class="blockList">
  179. <li class="blockList"><a name="field.summary">
  180. <!-- -->
  181. </a>
  182. <h3>Field Summary</h3>
  183. <ul class="blockList">
  184. <li class="blockList"><a name="fields.inherited.from.class.java.io.FilterInputStream">
  185. <!-- -->
  186. </a>
  187. <h3>Fields inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">FilterInputStream</a></h3>
  188. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true#in" title="class or interface in java.io">in</a></code></li>
  189. </ul>
  190. </li>
  191. </ul>
  192. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  193. <ul class="blockList">
  194. <li class="blockList"><a name="constructor.summary">
  195. <!-- -->
  196. </a>
  197. <h3>Constructor Summary</h3>
  198. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  199. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  200. <tr>
  201. <th class="colOne" scope="col">Constructor and Description</th>
  202. </tr>
  203. <tr class="altColor">
  204. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html#MessageDigestCalculatingInputStream-java.io.InputStream-">MessageDigestCalculatingInputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pStream)</code>
  205. <div class="block">Creates a new instance, which calculates a signature on the given stream,
  206. using a <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a> with the "MD5" algorithm.</div>
  207. </td>
  208. </tr>
  209. <tr class="rowColor">
  210. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html#MessageDigestCalculatingInputStream-java.io.InputStream-java.security.MessageDigest-">MessageDigestCalculatingInputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pStream,
  211. <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security">MessageDigest</a>&nbsp;pDigest)</code>
  212. <div class="block">Creates a new instance, which calculates a signature on the given stream,
  213. using the given <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a>.</div>
  214. </td>
  215. </tr>
  216. <tr class="altColor">
  217. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html#MessageDigestCalculatingInputStream-java.io.InputStream-java.lang.String-">MessageDigestCalculatingInputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pStream,
  218. <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;pAlgorithm)</code>
  219. <div class="block">Creates a new instance, which calculates a signature on the given stream,
  220. using a <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a> with the given algorithm.</div>
  221. </td>
  222. </tr>
  223. </table>
  224. </li>
  225. </ul>
  226. <!-- ========== METHOD SUMMARY =========== -->
  227. <ul class="blockList">
  228. <li class="blockList"><a name="method.summary">
  229. <!-- -->
  230. </a>
  231. <h3>Method Summary</h3>
  232. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  233. <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>
  234. <tr>
  235. <th class="colFirst" scope="col">Modifier and Type</th>
  236. <th class="colLast" scope="col">Method and Description</th>
  237. </tr>
  238. <tr id="i0" class="altColor">
  239. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security">MessageDigest</a></code></td>
  240. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html#getMessageDigest--">getMessageDigest</a></span>()</code>
  241. <div class="block">Returns the <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a>, which is being used for generating the
  242. checksum.</div>
  243. </td>
  244. </tr>
  245. </table>
  246. <ul class="blockList">
  247. <li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.io.input.ObservableInputStream">
  248. <!-- -->
  249. </a>
  250. <h3>Methods inherited from class&nbsp;org.apache.commons.io.input.<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input">ObservableInputStream</a></h3>
  251. <code><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#add-org.apache.commons.io.input.ObservableInputStream.Observer-">add</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#close--">close</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#consume--">consume</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#getObservers--">getObservers</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteClosed--">noteClosed</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteDataByte-int-">noteDataByte</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteDataBytes-byte:A-int-int-">noteDataBytes</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteError-java.io.IOException-">noteError</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteFinished--">noteFinished</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read--">read</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read-byte:A-">read</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read-byte:A-int-int-">read</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#remove-org.apache.commons.io.input.ObservableInputStream.Observer-">remove</a>, <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#removeAllObservers--">removeAllObservers</a></code></li>
  252. </ul>
  253. <ul class="blockList">
  254. <li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.io.input.ProxyInputStream">
  255. <!-- -->
  256. </a>
  257. <h3>Methods inherited from class&nbsp;org.apache.commons.io.input.<a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></h3>
  258. <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#afterRead-int-">afterRead</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#available--">available</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#beforeRead-int-">beforeRead</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#handleIOException-java.io.IOException-">handleIOException</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#mark-int-">mark</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#markSupported--">markSupported</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#reset--">reset</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#skip-long-">skip</a></code></li>
  259. </ul>
  260. <ul class="blockList">
  261. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  262. <!-- -->
  263. </a>
  264. <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>
  265. <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>
  266. </ul>
  267. </li>
  268. </ul>
  269. </li>
  270. </ul>
  271. </div>
  272. <div class="details">
  273. <ul class="blockList">
  274. <li class="blockList">
  275. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  276. <ul class="blockList">
  277. <li class="blockList"><a name="constructor.detail">
  278. <!-- -->
  279. </a>
  280. <h3>Constructor Detail</h3>
  281. <a name="MessageDigestCalculatingInputStream-java.io.InputStream-java.security.MessageDigest-">
  282. <!-- -->
  283. </a>
  284. <ul class="blockList">
  285. <li class="blockList">
  286. <h4>MessageDigestCalculatingInputStream</h4>
  287. <pre>public&nbsp;MessageDigestCalculatingInputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pStream,
  288. <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security">MessageDigest</a>&nbsp;pDigest)</pre>
  289. <div class="block">Creates a new instance, which calculates a signature on the given stream,
  290. using the given <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a>.</div>
  291. <dl>
  292. <dt><span class="paramLabel">Parameters:</span></dt>
  293. <dd><code>pStream</code> - the stream to calculate the message digest for</dd>
  294. <dd><code>pDigest</code> - the message digest to use</dd>
  295. </dl>
  296. </li>
  297. </ul>
  298. <a name="MessageDigestCalculatingInputStream-java.io.InputStream-java.lang.String-">
  299. <!-- -->
  300. </a>
  301. <ul class="blockList">
  302. <li class="blockList">
  303. <h4>MessageDigestCalculatingInputStream</h4>
  304. <pre>public&nbsp;MessageDigestCalculatingInputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pStream,
  305. <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;pAlgorithm)
  306. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/security/NoSuchAlgorithmException.html?is-external=true" title="class or interface in java.security">NoSuchAlgorithmException</a></pre>
  307. <div class="block">Creates a new instance, which calculates a signature on the given stream,
  308. using a <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a> with the given algorithm.</div>
  309. <dl>
  310. <dt><span class="paramLabel">Parameters:</span></dt>
  311. <dd><code>pStream</code> - the stream to calculate the message digest for</dd>
  312. <dd><code>pAlgorithm</code> - the name of the algorithm to use</dd>
  313. <dt><span class="throwsLabel">Throws:</span></dt>
  314. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/security/NoSuchAlgorithmException.html?is-external=true" title="class or interface in java.security">NoSuchAlgorithmException</a></code> - if no Provider supports a MessageDigestSpi implementation for the specified algorithm.</dd>
  315. </dl>
  316. </li>
  317. </ul>
  318. <a name="MessageDigestCalculatingInputStream-java.io.InputStream-">
  319. <!-- -->
  320. </a>
  321. <ul class="blockListLast">
  322. <li class="blockList">
  323. <h4>MessageDigestCalculatingInputStream</h4>
  324. <pre>public&nbsp;MessageDigestCalculatingInputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pStream)
  325. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/security/NoSuchAlgorithmException.html?is-external=true" title="class or interface in java.security">NoSuchAlgorithmException</a></pre>
  326. <div class="block">Creates a new instance, which calculates a signature on the given stream,
  327. using a <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a> with the "MD5" algorithm.</div>
  328. <dl>
  329. <dt><span class="paramLabel">Parameters:</span></dt>
  330. <dd><code>pStream</code> - the stream to calculate the message digest for</dd>
  331. <dt><span class="throwsLabel">Throws:</span></dt>
  332. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/security/NoSuchAlgorithmException.html?is-external=true" title="class or interface in java.security">NoSuchAlgorithmException</a></code> - if no Provider supports a MessageDigestSpi implementation for the specified algorithm.</dd>
  333. </dl>
  334. </li>
  335. </ul>
  336. </li>
  337. </ul>
  338. <!-- ============ METHOD DETAIL ========== -->
  339. <ul class="blockList">
  340. <li class="blockList"><a name="method.detail">
  341. <!-- -->
  342. </a>
  343. <h3>Method Detail</h3>
  344. <a name="getMessageDigest--">
  345. <!-- -->
  346. </a>
  347. <ul class="blockListLast">
  348. <li class="blockList">
  349. <h4>getMessageDigest</h4>
  350. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security">MessageDigest</a>&nbsp;getMessageDigest()</pre>
  351. <div class="block">Returns the <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a>, which is being used for generating the
  352. checksum.
  353. <em>Note</em>: The checksum will only reflect the data, which has been read so far.
  354. This is probably not, what you expect. Make sure, that the complete data has been
  355. read, if that is what you want. The easiest way to do so is by invoking
  356. <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#consume--"><code>ObservableInputStream.consume()</code></a>.</div>
  357. <dl>
  358. <dt><span class="returnLabel">Returns:</span></dt>
  359. <dd>the message digest used</dd>
  360. </dl>
  361. </li>
  362. </ul>
  363. </li>
  364. </ul>
  365. </li>
  366. </ul>
  367. </div>
  368. </div>
  369. <!-- ========= END OF CLASS DATA ========= -->
  370. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  371. <div class="bottomNav"><a name="navbar.bottom">
  372. <!-- -->
  373. </a>
  374. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  375. <a name="navbar.bottom.firstrow">
  376. <!-- -->
  377. </a>
  378. <ul class="navList" title="Navigation">
  379. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  380. <li><a href="package-summary.html">Package</a></li>
  381. <li class="navBarCell1Rev">Class</li>
  382. <li><a href="class-use/MessageDigestCalculatingInputStream.html">Use</a></li>
  383. <li><a href="package-tree.html">Tree</a></li>
  384. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  385. <li><a href="../../../../../index-all.html">Index</a></li>
  386. <li><a href="../../../../../help-doc.html">Help</a></li>
  387. </ul>
  388. </div>
  389. <div class="subNav">
  390. <ul class="navList">
  391. <li><a href="../../../../../org/apache/commons/io/input/InfiniteCircularInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  392. <li><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  393. </ul>
  394. <ul class="navList">
  395. <li><a href="../../../../../index.html?org/apache/commons/io/input/MessageDigestCalculatingInputStream.html" target="_top">Frames</a></li>
  396. <li><a href="MessageDigestCalculatingInputStream.html" target="_top">No&nbsp;Frames</a></li>
  397. </ul>
  398. <ul class="navList" id="allclasses_navbar_bottom">
  399. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  400. </ul>
  401. <div>
  402. <script type="text/javascript"><!--
  403. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  404. if(window==top) {
  405. allClassesLink.style.display = "block";
  406. }
  407. else {
  408. allClassesLink.style.display = "none";
  409. }
  410. //-->
  411. </script>
  412. </div>
  413. <div>
  414. <ul class="subNavList">
  415. <li>Summary:&nbsp;</li>
  416. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  417. <li><a href="#fields.inherited.from.class.java.io.FilterInputStream">Field</a>&nbsp;|&nbsp;</li>
  418. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  419. <li><a href="#method.summary">Method</a></li>
  420. </ul>
  421. <ul class="subNavList">
  422. <li>Detail:&nbsp;</li>
  423. <li>Field&nbsp;|&nbsp;</li>
  424. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  425. <li><a href="#method.detail">Method</a></li>
  426. </ul>
  427. </div>
  428. <a name="skip.navbar.bottom">
  429. <!-- -->
  430. </a></div>
  431. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  432. <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>
  433. </body>
  434. </html>