/lib/bouncycastle/docs/org/bouncycastle/jce/provider/util/NullDigest.html
HTML | 393 lines | 328 code | 43 blank | 22 comment | 0 complexity | 11642eeb02a9079fd19c0e646a700019 MD5 | raw file
Possible License(s): LGPL-2.1, BSD-3-Clause, Apache-2.0
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0) on Mon Jan 11 13:46:41 EST 2010 -->
6<TITLE>
7NullDigest (Bouncy Castle Library 1.45 API Specification)
8</TITLE>
9
10<META NAME="date" CONTENT="2010-01-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 if (location.href.indexOf('is-external=true') == -1) {
18 parent.document.title="NullDigest (Bouncy Castle Library 1.45 API Specification)";
19 }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39 <TR ALIGN="center" VALIGN="top">
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
47 </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51<b>Bouncy Castle Cryptography Library 1.45</b></EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 PREV CLASS
58 NEXT CLASS</FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60 <A HREF="../../../../../index.html?org/bouncycastle/jce/provider/util/NullDigest.html" target="_top"><B>FRAMES</B></A>
61 <A HREF="NullDigest.html" target="_top"><B>NO FRAMES</B></A>
62 <SCRIPT type="text/javascript">
63 <!--
64 if(window==top) {
65 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66 }
67 //-->
68</SCRIPT>
69<NOSCRIPT>
70 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90org.bouncycastle.jce.provider.util</FONT>
91<BR>
92Class NullDigest</H2>
93<PRE>
94java.lang.Object
95 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.bouncycastle.jce.provider.util.NullDigest</B>
96</PRE>
97<DL>
98<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public class <B>NullDigest</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></DL>
103</PRE>
104
105<P>
106<HR>
107
108<P>
109
110<!-- ======== CONSTRUCTOR SUMMARY ======== -->
111
112<A NAME="constructor_summary"><!-- --></A>
113<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
114<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
116<B>Constructor Summary</B></FONT></TH>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
119<TD><CODE><B><A HREF="../../../../../org/bouncycastle/jce/provider/util/NullDigest.html#NullDigest()">NullDigest</A></B>()</CODE>
120
121<BR>
122 </TD>
123</TR>
124</TABLE>
125
126<!-- ========== METHOD SUMMARY =========== -->
127
128<A NAME="method_summary"><!-- --></A>
129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
131<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
132<B>Method Summary</B></FONT></TH>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136<CODE> int</CODE></FONT></TD>
137<TD><CODE><B><A HREF="../../../../../org/bouncycastle/jce/provider/util/NullDigest.html#doFinal(byte[], int)">doFinal</A></B>(byte[] out,
138 int outOff)</CODE>
139
140<BR>
141 close the digest, producing the final digest value.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE> java.lang.String</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../org/bouncycastle/jce/provider/util/NullDigest.html#getAlgorithmName()">getAlgorithmName</A></B>()</CODE>
147
148<BR>
149 return the algorithm name</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE> int</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../org/bouncycastle/jce/provider/util/NullDigest.html#getDigestSize()">getDigestSize</A></B>()</CODE>
155
156<BR>
157 return the size, in bytes, of the digest produced by this message digest.</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE> void</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../org/bouncycastle/jce/provider/util/NullDigest.html#reset()">reset</A></B>()</CODE>
163
164<BR>
165 reset the digest back to it's initial state.</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE> void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../../org/bouncycastle/jce/provider/util/NullDigest.html#update(byte)">update</A></B>(byte in)</CODE>
171
172<BR>
173 update the message digest with a single byte.</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE> void</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../org/bouncycastle/jce/provider/util/NullDigest.html#update(byte[], int, int)">update</A></B>(byte[] in,
179 int inOff,
180 int len)</CODE>
181
182<BR>
183 update the message digest with a block of bytes.</TD>
184</TR>
185</TABLE>
186 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
193</TR>
194</TABLE>
195
196<P>
197
198<!-- ========= CONSTRUCTOR DETAIL ======== -->
199
200<A NAME="constructor_detail"><!-- --></A>
201<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
204<B>Constructor Detail</B></FONT></TH>
205</TR>
206</TABLE>
207
208<A NAME="NullDigest()"><!-- --></A><H3>
209NullDigest</H3>
210<PRE>
211public <B>NullDigest</B>()</PRE>
212<DL>
213</DL>
214
215<!-- ============ METHOD DETAIL ========== -->
216
217<A NAME="method_detail"><!-- --></A>
218<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
219<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
220<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
221<B>Method Detail</B></FONT></TH>
222</TR>
223</TABLE>
224
225<A NAME="getAlgorithmName()"><!-- --></A><H3>
226getAlgorithmName</H3>
227<PRE>
228public java.lang.String <B>getAlgorithmName</B>()</PRE>
229<DL>
230<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#getAlgorithmName()">Digest</A></CODE></B></DD>
231<DD>return the algorithm name
232<P>
233<DD><DL>
234<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#getAlgorithmName()">getAlgorithmName</A></CODE> in interface <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></CODE></DL>
235</DD>
236<DD><DL>
237
238<DT><B>Returns:</B><DD>the algorithm name</DL>
239</DD>
240</DL>
241<HR>
242
243<A NAME="getDigestSize()"><!-- --></A><H3>
244getDigestSize</H3>
245<PRE>
246public int <B>getDigestSize</B>()</PRE>
247<DL>
248<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#getDigestSize()">Digest</A></CODE></B></DD>
249<DD>return the size, in bytes, of the digest produced by this message digest.
250<P>
251<DD><DL>
252<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#getDigestSize()">getDigestSize</A></CODE> in interface <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></CODE></DL>
253</DD>
254<DD><DL>
255
256<DT><B>Returns:</B><DD>the size, in bytes, of the digest produced by this message digest.</DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="update(byte)"><!-- --></A><H3>
262update</H3>
263<PRE>
264public void <B>update</B>(byte in)</PRE>
265<DL>
266<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#update(byte)">Digest</A></CODE></B></DD>
267<DD>update the message digest with a single byte.
268<P>
269<DD><DL>
270<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#update(byte)">update</A></CODE> in interface <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></CODE></DL>
271</DD>
272<DD><DL>
273<DT><B>Parameters:</B><DD><CODE>in</CODE> - the input byte to be entered.</DL>
274</DD>
275</DL>
276<HR>
277
278<A NAME="update(byte[], int, int)"><!-- --></A><H3>
279update</H3>
280<PRE>
281public void <B>update</B>(byte[] in,
282 int inOff,
283 int len)</PRE>
284<DL>
285<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#update(byte[], int, int)">Digest</A></CODE></B></DD>
286<DD>update the message digest with a block of bytes.
287<P>
288<DD><DL>
289<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#update(byte[], int, int)">update</A></CODE> in interface <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></CODE></DL>
290</DD>
291<DD><DL>
292<DT><B>Parameters:</B><DD><CODE>in</CODE> - the byte array containing the data.<DD><CODE>inOff</CODE> - the offset into the byte array where the data starts.<DD><CODE>len</CODE> - the length of the data.</DL>
293</DD>
294</DL>
295<HR>
296
297<A NAME="doFinal(byte[], int)"><!-- --></A><H3>
298doFinal</H3>
299<PRE>
300public int <B>doFinal</B>(byte[] out,
301 int outOff)</PRE>
302<DL>
303<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#doFinal(byte[], int)">Digest</A></CODE></B></DD>
304<DD>close the digest, producing the final digest value. The doFinal
305 call leaves the digest reset.
306<P>
307<DD><DL>
308<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#doFinal(byte[], int)">doFinal</A></CODE> in interface <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></CODE></DL>
309</DD>
310<DD><DL>
311<DT><B>Parameters:</B><DD><CODE>out</CODE> - the array the digest is to be copied into.<DD><CODE>outOff</CODE> - the offset into the out array the digest is to start at.</DL>
312</DD>
313</DL>
314<HR>
315
316<A NAME="reset()"><!-- --></A><H3>
317reset</H3>
318<PRE>
319public void <B>reset</B>()</PRE>
320<DL>
321<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#reset()">Digest</A></CODE></B></DD>
322<DD>reset the digest back to it's initial state.
323<P>
324<DD><DL>
325<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../org/bouncycastle/crypto/Digest.html" title="interface in org.bouncycastle.crypto">Digest</A></CODE></DL>
326</DD>
327<DD><DL>
328</DL>
329</DD>
330</DL>
331<!-- ========= END OF CLASS DATA ========= -->
332<HR>
333
334
335<!-- ======= START OF BOTTOM NAVBAR ====== -->
336<A NAME="navbar_bottom"><!-- --></A>
337<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
338<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
339<TR>
340<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
341<A NAME="navbar_bottom_firstrow"><!-- --></A>
342<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
343 <TR ALIGN="center" VALIGN="top">
344 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
345 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
346 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
347 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
348 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
350 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
351 </TR>
352</TABLE>
353</TD>
354<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
355<b>Bouncy Castle Cryptography Library 1.45</b></EM>
356</TD>
357</TR>
358
359<TR>
360<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
361 PREV CLASS
362 NEXT CLASS</FONT></TD>
363<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
364 <A HREF="../../../../../index.html?org/bouncycastle/jce/provider/util/NullDigest.html" target="_top"><B>FRAMES</B></A>
365 <A HREF="NullDigest.html" target="_top"><B>NO FRAMES</B></A>
366 <SCRIPT type="text/javascript">
367 <!--
368 if(window==top) {
369 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
370 }
371 //-->
372</SCRIPT>
373<NOSCRIPT>
374 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
375</NOSCRIPT>
376
377
378</FONT></TD>
379</TR>
380<TR>
381<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
382 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
383<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
384DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
385</TR>
386</TABLE>
387<A NAME="skip-navbar_bottom"></A>
388<!-- ======== END OF BOTTOM NAVBAR ======= -->
389
390<HR>
391
392</BODY>
393</HTML>