javax.imageio.stream

クラス FileCacheImageOutputStream

java.lang.Object

javax.imageio.stream.ImageInputStreamImpl

javax.imageio.stream.ImageOutputStreamImpl

javax.imageio.stream.FileCacheImageOutputStream

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

Closeable, DataInput, DataOutput, AutoCloseable, 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() この FileCacheImageOutputStream を閉じます。
void	flushBefore(long pos) 指示された位置より前の初期のストリーム部分を破棄します。
boolean	isCached() 後方へのシークを可能にするために、この ImageOutputStream がデータをキャッシュするため、true が返されます。
boolean	isCachedFile() この ImageOutputStream はファイルキャッシュを維持するため、true が返されます。
boolean	isCachedMemory() この ImageOutputStream はメインメモリーキャッシュを維持しないため、false が返されます。
long	length() ストリームが未知の長さであることを示す -1L を返します。
int	read() ストリームから 1 バイトを読み込み、それを 0 から 255 までの int として返します。
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

クラスからコピーされた説明: ImageInputStreamImpl

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

サブクラスでこのメソッドを実装する必要があります。サブクラス実装で終了する前にストリーム位置を更新します。

ストリーム内のビットオフセットは、読み込みを行う前に 0 にリセットする必要があります。

定義:

read、インタフェース: ImageInputStream

定義:

read、クラス: ImageInputStreamImpl

戻り値:

ストリーム内の次のバイトの値。または、EOF に達した場合は -1。

例外:

IOException - ストリームが閉じられている場合。

read

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

クラスからコピーされた説明: ImageInputStreamImpl

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

ストリーム内のビットオフセットは、読み込みを行う前に 0 にリセットする必要があります。

サブクラスでこのメソッドを実装する必要があります。サブクラス実装で終了する前にストリーム位置を更新します。

定義:

read、インタフェース: ImageInputStream

定義:

read、クラス: ImageInputStreamImpl

パラメータ:

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

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

len - 読み込む最大バイト数。

戻り値:

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

例外:

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

write

public void write(int b)
           throws IOException

インタフェースからコピーされた説明: ImageOutputStream

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

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

定義:

write、インタフェース: DataOutput

定義:

write、インタフェース: ImageOutputStream

定義:

write、クラス: ImageOutputStreamImpl

パラメータ:

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

例外:

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

write

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

インタフェースからコピーされた説明: ImageOutputStream

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

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

定義:

write、インタフェース: DataOutput

定義:

write、インタフェース: ImageOutputStream

定義:

write、クラス: ImageOutputStreamImpl

パラメータ:

b - 書き込まれる byte 配列。

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

len - 書き込む byte 数。

例外:

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

length

public long length()

クラスからコピーされた説明: ImageInputStreamImpl

ストリームが未知の長さであることを示す -1L を返します。サブクラスでこのメソッドをオーバーライドして、実際の長さの情報を指定する必要があります。

定義:

length、インタフェース: ImageInputStream

オーバーライド:

length、クラス: ImageInputStreamImpl

戻り値:

未知の長さを示す -1L

seek

public void seek(long pos)
          throws IOException

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

定義:

seek、インタフェース: ImageInputStream

オーバーライド:

seek、クラス: ImageInputStreamImpl

パラメータ:

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

例外:

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

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

isCached

public boolean isCached()

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

定義:

isCached、インタフェース: ImageInputStream

オーバーライド:

isCached、クラス: ImageInputStreamImpl

戻り値:

true.

関連項目:

isCachedMemory(), isCachedFile()

isCachedFile

public boolean isCachedFile()

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

定義:

isCachedFile、インタフェース: ImageInputStream

オーバーライド:

isCachedFile、クラス: ImageInputStreamImpl

戻り値:

true.

関連項目:

isCached(), isCachedMemory()

isCachedMemory

public boolean isCachedMemory()

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

定義:

isCachedMemory、インタフェース: ImageInputStream

オーバーライド:

isCachedMemory、クラス: ImageInputStreamImpl

戻り値:

false.

関連項目:

isCached(), isCachedFile()

close

public void close()
           throws IOException

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

定義:

close、インタフェース: Closeable

定義:

close、インタフェース: AutoCloseable

定義:

close、インタフェース: ImageInputStream

オーバーライド:

close、クラス: ImageInputStreamImpl

例外:

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

flushBefore

public void flushBefore(long pos)
                 throws IOException

インタフェースからコピーされた説明: ImageInputStream

指示された位置より前の初期のストリーム部分を破棄します。ストリームのフラッシュされた部分内のオフセットにシークしようとすると、IndexOutOfBoundsException がスローされます。

flushBefore を呼び出すと、このインタフェースを実装するクラスが、ストリームからデータを格納するのに使用するメモリーやディスクスペースなどのリソースを解放できます。

定義:

flushBefore、インタフェース: ImageInputStream

定義:

flushBefore、インタフェース: ImageOutputStream

オーバーライド:

flushBefore、クラス: ImageInputStreamImpl

パラメータ:

pos - フラッシュされるストリーム接頭辞の長さを示す long。

例外:

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