JavaTM 2 Platform
Std. Ed. v1.3

java.security
クラス DigestOutputStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--java.io.FilterOutputStream
              |
              +--java.security.DigestOutputStream

public class DigestOutputStream
extends FilterOutputStream

ストリームを通過するビットを使用して、関連したメッセージダイジェストを更新する透明なストリームです。

メッセージダイジェスト計算を完了するには、このダイジェスト出力ストリームの write メソッドの 1 つを呼び出したあと、関連したメッセージダイジェストに対して digest メソッドの 1 つを呼び出します。

このストリームをオンまたはオフすることができます (on を参照)。オンの場合、write メソッドの 1 つを呼び出すと、メッセージダイジェストが更新されます。ただし、オフの場合には、メッセージダイジェストは更新されません。ストリームに対するデフォルトはオンです。

関連項目:
MessageDigest, DigestInputStream

フィールドの概要
protected  MessageDigest digest
          このストリームに関連したメッセージダイジェストです。
 
クラス java.io.FilterOutputStream から継承したフィールド
out
 
コンストラクタの概要
DigestOutputStream(OutputStream stream, MessageDigest digest)
          指定された出力ストリームとメッセージダイジェストを使用して、ダイジェストを出力するストリームを作成します。
 
メソッドの概要
 MessageDigest getMessageDigest()
          このストリームに関連したメッセージダイジェストを返します。
 void on(boolean on)
          ダイジェスト機能をオンまたはオフにします。
 void setMessageDigest(MessageDigest digest)
          指定されたメッセージダイジェストをこのストリームに関連付けます。
 String toString()
          このダイジェスト出力ストリームとそれに関連したメッセージダイジェストオブジェクトの文字列表現を出力します。
 void write(byte[] b, int off, int len)
          ダイジェスト機能がオンの場合に指定された部分配列を使用して、メッセージダイジェストを更新し、どのような場合でもその部分配列を出力ストリームに書き込みます。
 void write(int b)
          指定されたバイトを使用して (ダイジェスト機能がオンの場合に) メッセージダイジェストを更新し、どのような場合でもそのバイトを出力ストリームに書き込みます。
 
クラス java.io.FilterOutputStream から継承したメソッド
close, flush, write
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

digest

protected MessageDigest digest
このストリームに関連したメッセージダイジェストです。
コンストラクタの詳細

DigestOutputStream

public DigestOutputStream(OutputStream stream,
                          MessageDigest digest)
指定された出力ストリームとメッセージダイジェストを使用して、ダイジェストを出力するストリームを作成します。
パラメータ:
stream - 出力ストリーム
digest - このストリームに関連させるメッセージダイジェスト
メソッドの詳細

getMessageDigest

public MessageDigest getMessageDigest()
このストリームに関連したメッセージダイジェストを返します。
戻り値:
このストリームに関連したメッセージダイジェスト
関連項目:
setMessageDigest(java.security.MessageDigest)

setMessageDigest

public void setMessageDigest(MessageDigest digest)
指定されたメッセージダイジェストをこのストリームに関連付けます。
パラメータ:
digest - このストリームに関連したメッセージダイジェスト
関連項目:
getMessageDigest()

write

public void write(int b)
           throws IOException
指定されたバイトを使用して (ダイジェスト機能がオンの場合に) メッセージダイジェストを更新し、どのような場合でもそのバイトを出力ストリームに書き込みます。すなわち、ダイジェスト機能がオン (on を参照) の場合には、このメソッドは、そのストリームに関連したメッセージダイジェストに対して update を呼び出し、バイト b を渡します。メソッドはその後、そのバイトを出力ストリームに書き込み、そのバイトの書き込みが完了するまで次の書き込みを行わせません。
オーバーライド:
クラス FilterOutputStream 内の write
パラメータ:
b - 出力ストリームに更新および書き込みを行うのに使用するバイト
例外:
IOException - 入出力エラーが発生した場合
関連項目:
MessageDigest.update(byte)

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
ダイジェスト機能がオンの場合に指定された部分配列を使用して、メッセージダイジェストを更新し、どのような場合でもその部分配列を出力ストリームに書き込みます。すなわち、ダイジェスト機能がオン (on を参照) の場合には、このメソッドは、そのストリームに関連したメッセージダイジェストに対して update を呼び出し、指定された部分配列を渡します。メソッドはその後、部分配列のバイト群を出力ストリームに書き込み、そのバイト群の書き込みが完了するまで次の書き込みを行わせません。
オーバーライド:
クラス FilterOutputStream 内の write
パラメータ:
b - 出力ストリームに更新および書き込みを行うのに使用する部分配列を含む配列
off - b 内の、更新および書き込みを行う先頭バイトのオフセット
len - オフセット off から開始して、b から更新および書き込みを行うデータのバイト数
例外:
IOException - 入出力エラーが発生した場合
関連項目:
MessageDigest.update(byte[], int, int)

on

public void on(boolean on)
ダイジェスト機能をオンまたはオフにします。デフォルトはオンです。オンの場合、write の 1 つに対する呼び出しは、メッセージダイジェストを更新します。ただし、オフの場合にはメッセージダイジェストは更新されません。
パラメータ:
on - ダイジェスト機能をオンにする場合は true、オフにする場合は false

toString

public String toString()
このダイジェスト出力ストリームとそれに関連したメッセージダイジェストオブジェクトの文字列表現を出力します。
オーバーライド:
クラス Object 内の toString
クラス java.lang.Object からコピーされたタグ:
戻り値:
このオブジェクトの文字列表現

JavaTM 2 Platform
Std. Ed. v1.3

バグや機能要求の報告
さらに詳しい API リファレンスおよび開発者ドキュメントについては、 Java 2 SDK SE Developer Documentation を参照してください。このドキュメントには、概念、用語の定義、回避策、 実用的なコード例など、開発者を対象にした詳細な解説が掲載されています。

Java、Java 2D、JDBC は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.