javax.imageio.stream
クラス FileCacheImageOutputStream

java.lang.Object
  |
  +--javax.imageio.stream.ImageInputStreamImpl
        |
        +--javax.imageio.stream.ImageOutputStreamImpl
              |
              +--javax.imageio.stream.FileCacheImageOutputStream

すべての実装インタフェース:

DataInput, DataOutput, ImageInputStream, ImageOutputStream

public class FileCacheImageOutputStream

extends ImageOutputStreamImpl

出力を通常の OutputStream に書き込む ImageOutputStream の実装です。ファイルは、データを出力ストリームにフラッシュするまでキャッシュとして使用されます。

フィールドの概要

クラス javax.imageio.stream.ImageInputStreamImpl から継承したフィールド

bitOffset, byteOrder, flushedPos, streamPos

コンストラクタの概要

FileCacheImageOutputStream(OutputStream stream, File cacheDir)
指定された outputStream への書き込みを行う FileCacheImageOutputStream を構築します。

メソッドの概要

void	close() この FileCacheImageOututStream を閉じます。
void	flushBefore(long pos) 指定された位置より前のデータをすべて、OutputStream や File などの基本となる出力先にフラッシュします。
boolean	isCached() 後方へのシークを可能にするために、この ImageOutputStream がデータをキャッシュするため、true が返されます。
boolean	isCachedFile() この ImageOutputStream はファイルキャッシュを維持するため、true が返されます。
boolean	isCachedMemory() この ImageOutputStream はメインメモリキャッシュを維持しないため、false が返されます。
long	length() 既知の場合、ストリームの全長を返します。
int	read() ストリームから 1 バイトを読み込み、それを 0 から 255 までの整数として返します。
int	read(byte[] b, int off, int len) ストリームから len バイトまで読み込み、b にインデックス off から格納します。
void	seek(long pos) 現在のストリーム位置を設定してビットオフセットを 0 にリセットします。
void	write(byte[] b, int off, int len) バイトのシーケンスをストリームの現在位置に書き込みます。
void	write(int b) ストリームの現在の位置に 1 バイト書き込みます。

クラス javax.imageio.stream.ImageOutputStreamImpl から継承したメソッド

flushBits, write, writeBit, writeBits, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeChars, writeDouble, writeDoubles, writeFloat, writeFloats, writeInt, writeInts, writeLong, writeLongs, writeShort, writeShorts, writeUTF

クラス javax.imageio.stream.ImageInputStreamImpl から継承したメソッド

checkClosed, finalize, flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, mark, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, setBitOffset, setByteOrder, skipBytes, skipBytes

クラス java.lang.Object から継承したメソッド

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェース javax.imageio.stream.ImageInputStream から継承したメソッド

flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, mark, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, setBitOffset, setByteOrder, skipBytes, skipBytes

コンストラクタの詳細

FileCacheImageOutputStream

public FileCacheImageOutputStream(OutputStream stream,
                                  File cacheDir)
                           throws IOException

指定された outputStream への書き込みを行う FileCacheImageOutputStream を構築します。

一時ファイルがキャッシュとして使用されます。cacheDir が null ではなく、ディレクトリである場合、ファイルがそこに作成されます。null の場合、システム固有のデフォルト一時ファイルディレクトリが使用されます。詳細は File.createTempFile のドキュメントを参照してください。

パラメータ:

stream - 書き込み先の OutputStream

cacheDir - キャッシュファイルが作成される場所を示す File。システムディレクトリを使用する場合は null

例外:

IllegalArgumentException - stream が null の場合

IllegalArgumentException - cacheDir が null ではなく、ディレクトリでもない場合

IOException - キャッシュファイルを作成できない場合

メソッドの詳細

read

public int read()
         throws IOException

インタフェース ImageInputStream の記述:

ストリームから 1 バイトを読み込み、それを 0 から 255 までの整数として返します。ストリームの終わりに達すると -1 を返します。

ストリーム内のビットオフセットは読み込みを行う前に 0 にリセットされます。

定義:

インタフェース ImageInputStream 内の read

定義:

クラス ImageInputStreamImpl 内の read

戻り値:

ストリームからのバイト値 (int)、または -1 (EOF を示す)

例外:

IOException - 入出力エラーが発生した場合

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

インタフェース ImageInputStream の記述:

ストリームから len バイトまで読み込み、b にインデックス off から格納します。読み込んだバイト数を返します。ストリームの終わりに達したためにバイトを読み込めない場合は、-1 を返します。

ストリーム内のビットオフセットは、読み込みを行う前に 0 にリセットされます。

定義:

インタフェース ImageInputStream 内の read

定義:

クラス ImageInputStreamImpl 内の read

パラメータ:

b - 書き込まれるバイト配列

off - 書き込み先の b 内の開始位置

len - 読み込む最大 byte 数

戻り値:

実際に読み込まれたバイト数、または EOF を示す -1

例外:

IOException - 入出力エラーが発生した場合

write

public void write(int b)
           throws IOException

インタフェース ImageOutputStream の記述:

ストリームの現在の位置に 1 バイト書き込みます。b の上位 24 ビットは無視されます。

ストリーム内のビットオフセットがゼロでない場合、現在のバイトの残りは 0 でパディングされ、最初に書き込まれます。書き込み後は、ビットオフセットは 0 です。実装側は、ImageOutputStreamImpl のflushBits メソッドを使用してこれを保証できます。

定義:

インタフェース ImageOutputStream 内の write

定義:

クラス ImageOutputStreamImpl 内の write

パラメータ:

b - 下位 8 ビットが書き込まれる int

例外:

IOException - 入出力エラーが発生した場合

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

インタフェース ImageOutputStream の記述:

バイトのシーケンスをストリームの現在位置に書き込みます。len が 0 の場合、何も書き込みません。バイト b[off] を最初に書き込み、次にバイト bo[off + 1] を書き込む、という具合になります。

ストリーム内のビットオフセットがゼロでない場合、現在のバイトの残りは 0 でパディングされ、最初に書き込まれます。書き込み後は、ビットオフセットは 0 です。実装側は、ImageOutputStreamImpl のflushBits メソッドを使用してこれを保証できます。

定義:

インタフェース ImageOutputStream 内の write

定義:

クラス ImageOutputStreamImpl 内の write

パラメータ:

b - 書き込まれる byte 配列

off - データの開始オフセット

len - 書き込み byte 数

例外:

IOException - 入出力エラーが発生した場合

length

public long length()

インタフェース ImageInputStream の記述:

既知の場合、ストリームの全長を返します。そうでない場合は -1 を返します。

定義:

インタフェース ImageInputStream 内の length

オーバーライド:

クラス ImageInputStreamImpl 内の length

戻り値:

既知の場合はストリームの長さの long、そうでない場合は -1

seek

public void seek(long pos)
          throws IOException

現在のストリーム位置を設定してビットオフセットを 0 にリセットします。シークでファイルの終りを通過することは正常で、EOFException は読み込みの場合にのみスローされます。書き込みが実行されるまで、ファイル長は増加しません。

定義:

インタフェース ImageInputStream 内の seek

オーバーライド:

クラス ImageInputStreamImpl 内の seek

パラメータ:

pos - 目的のファイルポインタ位置を示す long

例外:

IndexOutOfBoundsException - pos がフラッシュ位置よりも小さい場合

IOException - その他の入出力エラーが発生した場合

isCached

public boolean isCached()

後方へのシークを可能にするために、この ImageOutputStream がデータをキャッシュするため、true が返されます。

定義:

インタフェース ImageInputStream 内の isCached

オーバーライド:

クラス ImageInputStreamImpl 内の isCached

戻り値:

true

関連項目:

isCachedMemory(), isCachedFile()

isCachedFile

public boolean isCachedFile()

この ImageOutputStream はファイルキャッシュを維持するため、true が返されます。

定義:

インタフェース ImageInputStream 内の isCachedFile

オーバーライド:

クラス ImageInputStreamImpl 内の isCachedFile

戻り値:

true

関連項目:

isCached(), isCachedMemory()

isCachedMemory

public boolean isCachedMemory()

この ImageOutputStream はメインメモリキャッシュを維持しないため、false が返されます。

定義:

インタフェース ImageInputStream 内の isCachedMemory

オーバーライド:

クラス ImageInputStreamImpl 内の isCachedMemory

戻り値:

false

関連項目:

isCached(), isCachedFile()

close

public void close()
           throws IOException

この FileCacheImageOututStream を閉じます。保留中のデータはすべて出力にフラッシュされ、キャッシュファイルは閉じられて削除されます。出力先 OutputStream は閉じられません。

定義:

インタフェース ImageInputStream 内の close

オーバーライド:

クラス ImageInputStreamImpl 内の close

例外:

IOException - エラーが発生した場合

flushBefore

public void flushBefore(long pos)
                 throws IOException

インタフェース ImageOutputStream の記述:

指定された位置より前のデータをすべて、OutputStream や File などの基本となる出力先にフラッシュします。ストリームのフラッシュ部分にシークすると IndexOutOfBoundsException がスローされます。

定義:

インタフェース ImageOutputStream 内の flushBefore

オーバーライド:

クラス ImageInputStreamImpl 内の flushBefore

パラメータ:

pos - 出力先にフラッシュされるファイル接頭辞の長さを含む long

例外:

IOException - 入出力エラーが発生した場合